Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions DECISIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Design Decisions

This document records significant design decisions made during the implementation of the F# Compiler Regression Testing pipeline.

## Decision 1: Template-Based Architecture

**Context**: Need to implement regression testing that can be reused across pipelines.

**Options Considered**:
1. Inline job definitions in azure-pipelines-PR.yml
2. Reusable Azure DevOps template in eng/templates/

**Decision**: Use reusable template approach.

**Rationale**:
- Follows Azure DevOps best practices
- Reduces code duplication
- Makes it easy to extend with new libraries
- Consistent with existing patterns in the repository (eng/common/templates/)

---

## Decision 2: Optimized Artifact Publishing

**Context**: Need to share compiler artifacts between jobs.

**Options Considered**:
1. Publish entire artifacts folder (~1.8GB)
2. Publish only essential directories (fsc and FSharp.Core) (~79MB)

**Decision**: Publish only essential directories.

**Rationale**:
- Reduces artifact size from 1.8GB to ~79MB
- Faster artifact upload/download
- Contains all necessary components for regression testing
- Matches approach in previous PR #18803

---

## Decision 3: Using F# Script for Directory.Build.props Setup

**Context**: Need to inject UseLocalCompiler.Directory.Build.props import into third-party repos.

**Options Considered**:
1. Pure PowerShell XML manipulation
2. F# script with proper XML handling
3. Simple file replacement

**Decision**: Use F# script with XML handling.

**Rationale**:
- Properly handles existing Directory.Build.props files
- Correctly inserts import at beginning of Project element
- Native F# tooling in an F# project
- Matches approach in previous PR #18803

---

## Decision 4: Specific Commit SHAs for Third-Party Libraries

**Context**: Need reproducible regression tests.

**Options Considered**:
1. Use main/master branch
2. Use specific commit SHAs

**Decision**: Use specific commit SHAs.

**Rationale**:
- Ensures reproducible test results
- Protects against breaking changes in third-party libraries
- Allows controlled updates when ready
- Standard practice for regression testing

---

## Decision 5: Removal of Strategy Matrix from EndToEndBuildTests

**Context**: The original EndToEndBuildTests job had a matrix for regular vs experimental features.

**Options Considered**:
1. Keep the matrix and publish artifacts only from one configuration
2. Remove the matrix entirely
3. Publish artifacts from both configurations

**Decision**: Remove the matrix entirely (per previous PR approach).

**Rationale**:
- Simplifies artifact publishing
- Regression tests need consistent baseline
- Both configurations were building with empty experimental flag anyway
- Matches approach in previous PR #18803

---

## Decision 6: Use net10.0 Target Framework in Template

**Context**: The pipeline needs to reference the correct .NET target framework for the compiler artifacts.

**Options Considered**:
1. Hardcode net9.0 (as in PR #18803)
2. Use net10.0 (per current UseLocalCompiler.Directory.Build.props)
3. Make it configurable

**Decision**: Use net10.0 to match the current project state.

**Rationale**:
- The current repository uses .NET 10 SDK
- UseLocalCompiler.Directory.Build.props references net10.0 paths
- The artifacts/bin/fsc/Release/net10.0 directory exists
- PR #18803 used net9.0 because it was based on an older version of the repository
- Using net10.0 ensures compatibility with the current build output

---
11 changes: 11 additions & 0 deletions OBSTACLES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Obstacles Encountered

This document tracks any obstacles encountered during the implementation of the Azure DevOps regression testing template.

## Current Obstacles

None at this time.

## Resolved Obstacles

_(None yet)_
51 changes: 51 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# TODO: Azure DevOps Template for F# Compiler Regression Testing

## Overview
Implement a reusable Azure DevOps template for F# compiler regression testing, integrated with the existing PR pipeline infrastructure.

## Tasks

### Infrastructure Setup
- [x] Analyze existing PR pipeline structure (`azure-pipelines-PR.yml`)
- [x] Review previous PR #18803 implementation details
- [x] Understand `UseLocalCompiler.Directory.Build.props` configuration

### Implementation
- [x] Create `eng/templates/` directory
- [x] Create `eng/templates/regression-test-jobs.yml` template
- [x] Define parameters for testMatrix
- [x] Implement job that depends on EndToEndBuildTests
- [x] Add artifact download steps (FSharpCompilerFscArtifacts, FSharpCoreArtifacts, UseLocalCompilerProps)
- [x] Add third-party repo checkout step
- [x] Add .NET SDK installation step
- [x] Add Directory.Build.props setup step with F# script
- [x] Add environment reporting step
- [x] Add build execution step
- [x] Add artifact publishing step
- [x] Add result reporting step

### Integration
- [x] Update `azure-pipelines-PR.yml`:
- [x] Modify EndToEndBuildTests to publish focused artifacts
- [x] Remove strategy/matrix section from EndToEndBuildTests
- [x] Add artifact publishing tasks for fsc, FSharp.Core, and UseLocalCompiler props
- [x] Add template invocation with FSharpPlus test matrix

### Documentation
- [x] Create `docs/regression-testing-pipeline.md`
- [x] Purpose and overview
- [x] How it works
- [x] Current test matrix
- [x] Adding new libraries
- [x] Pipeline configuration
- [x] Troubleshooting
- [x] Technical details

### Validation
- [x] Verify YAML syntax is valid
- [x] Verify template structure matches Azure DevOps best practices
- [x] Ensure Release configuration is used throughout

## References
- Previous PR: https://github.com/dotnet/fsharp/pull/18803
- Files: `eng/templates/regression-test-jobs.yml`, `azure-pipelines-PR.yml`, `docs/regression-testing-pipeline.md`
55 changes: 34 additions & 21 deletions azure-pipelines-PR.yml
Original file line number Diff line number Diff line change
Expand Up @@ -700,35 +700,48 @@ stages:
pool:
name: $(DncEngPublicBuildPool)
demands: ImageOverride -equals $(_WindowsMachineQueueName)
strategy:
maxParallel: 2
matrix:
regular:
_experimental_flag: ''
experimental_features:
_experimental_flag: ''
steps:
- checkout: self
clean: true
# We first download a publicly available .NET SDK. That one has support for `path` in global.json. dotnet.cmd script can then download a version which is not yet shipped, but matches global.json.
- task: UseDotNet@2
displayName: install SDK
inputs:
packageType: sdk
version: '10.x'
includePreviewVersions: true
workingDirectory: $(Build.SourcesDirectory)
installationPath: $(Build.SourcesDirectory)/.dotnet
- script: .\Build.cmd -c Release -pack
env:
NativeToolsOnMachine: true
FSHARP_EXPERIMENTAL_FEATURES: $(_experimental_flag)
- script: .\tests\EndToEndBuildTests\EndToEndBuildTests.cmd -c Release
env:
FSHARP_EXPERIMENTAL_FEATURES: $(_experimental_flag)
displayName: End to end build tests
- script: .\eng\common\dotnet.cmd fsi .\tests\FSharp.Compiler.ComponentTests\CompilerCompatibilityTests.fsx
displayName: Compiler compatibility tests

# Publish artifacts for regression testing
- task: PublishPipelineArtifact@1
displayName: Publish F# Compiler FSC Artifacts for Regression Tests
inputs:
targetPath: '$(Build.SourcesDirectory)/artifacts/bin/fsc'
artifactName: 'FSharpCompilerFscArtifacts'
publishLocation: pipeline
condition: succeeded()

- task: PublishPipelineArtifact@1
displayName: Publish F# Core Artifacts for Regression Tests
inputs:
targetPath: '$(Build.SourcesDirectory)/artifacts/bin/FSharp.Core'
artifactName: 'FSharpCoreArtifacts'
publishLocation: pipeline
condition: succeeded()

- task: PublishPipelineArtifact@1
displayName: Publish UseLocalCompiler props file for Regression Tests
inputs:
targetPath: '$(Build.SourcesDirectory)/UseLocalCompiler.Directory.Build.props'
artifactName: 'UseLocalCompilerProps'
publishLocation: pipeline
condition: succeeded()

# F# Compiler Regression Tests using third-party libraries
- template: /eng/templates/regression-test-jobs.yml
parameters:
testMatrix:
- repo: fsprojects/FSharpPlus
commit: f614035b75922aba41ed6a36c2fc986a2171d2b8
buildScript: build.cmd
displayName: FSharpPlus

# Up-to-date - disabled due to it being flaky
#- job: UpToDate_Windows
Expand Down
Loading
Loading