Add matrix-based testing (Azure#2323)

* Add matrix based testing

* Restore save-package-properties call

* Remove session records from sparse checkout paths

Author: hallipr

eng/pipelines/templates/jobs/test.yml renamed to eng/pipelines/templates/jobs/ci.tests.yml

@@ -1,23 +1,40 @@
 parameters:
-- name: ServiceDirectory
-  type: string
-- name: Toolchain
+- name: UsePlatformContainer
+  type: boolean
+- name: OSName
   type: string
 - name: Matrix
   type: object
+- name: DependsOn
+  type: string
+- name: CloudConfig
+  type: object
+- name: ServiceDirectory
+  type: string
 - name: TimeoutInMinutes
   type: number
 - name: TestProxy
   type: boolean
-  default: true
 
 jobs:
-- job: Test_${{ parameters.Matrix.pool.os }}_${{ parameters.Toolchain }}
-  displayName: "Test: ${{ parameters.Matrix.pool.os }} ${{ parameters.Toolchain }}"
+- job:
+  displayName: "Test"
+  condition: and(succeeded(), ne(variables['Skip.Tests'],'true'), ne(${{ parameters.Matrix }}, '{}'))
   timeoutInMinutes: ${{ parameters.TimeoutInMinutes }}
-  condition: and(succeeded(), ne(variables['Skip.Tests'],'true'))
+  dependsOn: ${{ parameters.DependsOn }}
+
+  strategy:
+    matrix: $[ ${{ parameters.Matrix }} ]
 
-  pool: ${{ parameters.Matrix.pool }}
+  pool:
+    name: $(Pool)
+    # 1es pipeline templates converts `image` to demands: ImageOverride under the hood
+    # which is incompatible with image selection in the default non-1es hosted pools
+    ${{ if eq(parameters.OSName, 'macOS') }}:
+      vmImage: $(OSVmImage)
+    ${{ else }}:
+      image: $(OSVmImage)
+    os: ${{ parameters.OSName }}
 
   steps:
   - template: /eng/common/pipelines/templates/steps/sparse-checkout.yml
@@ -27,7 +44,7 @@ jobs:
 
   - template: /eng/pipelines/templates/steps/use-rust.yml@self
     parameters:
-      Toolchain: ${{ parameters.Toolchain }}
+      Toolchain: $(RustToolchainName)
 
   - template: /eng/common/pipelines/templates/steps/set-default-branch.yml@self
 

eng/pipelines/templates/jobs/ci.yml

@@ -1,40 +1,22 @@
 parameters:
 - name: ServiceDirectory
   type: string
-  default: auto
 - name: Artifacts
   type: object
-  default: []
 - name: PipelineArtifactName
   type: string
-  default: packages
-- name: TestTimeoutInMinutes
-  type: number
-  default: 60
 - name: TestPipeline
   type: boolean
-  default: false
-- name: BuildMatrix
+- name: TestProxy
+  type: boolean
+- name: TestTimeoutInMinutes
+  type: number
+- name: MatrixConfigs
+  type: object
+- name: MatrixFilters
+  type: object
+- name: MatrixReplace
   type: object
-  default:
-  - pool:
-      os: linux
-      name: $(LINUXPOOL)
-      image: $(LINUXVMIMAGE)
-    Toolchains: [stable, msrv, nightly]
-  - pool:
-      os: windows
-      name: $(WINDOWSPOOL)
-      image: $(WINDOWSVMIMAGE)
-    Toolchains: [stable, msrv, nightly]
-  - pool:
-      os: macOS
-      name: $(MACPOOL)
-      vmImage: $(MACVMIMAGE)
-    Toolchains: [stable, msrv, nightly]
-- name: AnalyzeToolchain
-  type: string
-  default: stable
 
 jobs:
 - template: /eng/pipelines/templates/jobs/pack.yml
@@ -44,17 +26,23 @@ jobs:
     TestPipeline: ${{ parameters.TestPipeline }}
     PipelineArtifactName: ${{ parameters.PipelineArtifactName }}
 
-- ${{ each matrix in parameters.BuildMatrix }}:
-  - ${{ each toolchain in matrix.Toolchains }}:
-    - template: /eng/pipelines/templates/jobs/test.yml
-      parameters:
-        ServiceDirectory: ${{ parameters.ServiceDirectory }}
-        Toolchain: ${{ toolchain }}
-        Matrix: ${{ matrix }}
-        TimeoutInMinutes: ${{ parameters.TestTimeoutInMinutes }}
-
 - template: /eng/pipelines/templates/jobs/analyze.yml
   parameters:
     ServiceDirectory: ${{ parameters.ServiceDirectory }}
-    Toolchain: ${{ parameters.AnalyzeToolchain }}
+    Toolchain: stable
     TimeoutInMinutes: ${{ parameters.TestTimeoutInMinutes }}
+
+- template: /eng/common/pipelines/templates/jobs/generate-job-matrix.yml
+  parameters:
+    JobTemplatePath: /eng/pipelines/templates/jobs/ci.tests.yml
+    MatrixConfigs: ${{ parameters.MatrixConfigs }}
+    MatrixFilters: ${{ parameters.MatrixFilters }}
+    MatrixReplace: ${{ parameters.MatrixReplace }}
+    CloudConfig:
+      Cloud: public
+    SparseCheckoutPaths:
+      - /*
+    AdditionalParameters:
+      ServiceDirectory: ${{ parameters.ServiceDirectory }}
+      TimeoutInMinutes: ${{ parameters.TestTimeoutInMinutes }}
+      TestProxy: ${{ parameters.TestProxy }}

eng/pipelines/templates/stages/archetype-sdk-client.yml

@@ -4,17 +4,34 @@ parameters:
 - name: Artifacts
   type: object
   default: []
+# Test Parameters
 - name: TestTimeoutInMinutes
   type: number
   default: 60
-- name: oneESTemplateTag
-  type: string
-  default: release
+- name: MatrixConfigs
+  type: object
+  default:
+  - Name: rust_ci_test_base
+    Path: eng/pipelines/templates/stages/platform-matrix.json
+    Selection: sparse
+    NonSparseParameters: RustToolchainName
+    GenerateVMJobs: true
+- name: AdditionalMatrixConfigs
+  type: object
+  default: []
+- name: MatrixFilters
+  type: object
+  default: []
+- name: MatrixReplace
+  type: object
+  default: []
+- name: TestProxy
+  type: boolean
+  default: true
 
 extends:
   template: /eng/pipelines/templates/stages/1es-redirect.yml
   parameters:
-    oneESTemplateTag: ${{ parameters.oneESTemplateTag }}
     autoBaseline: ${{ and(eq(variables['Build.DefinitionName'], 'rust - core'), eq(variables['Build.SourceBranchName'], 'main'), eq(variables['System.TeamProject'], 'internal')) }}
     stages:
     - stage: Build
@@ -25,17 +42,23 @@ extends:
       - template: /eng/pipelines/templates/jobs/ci.yml
         parameters:
           ServiceDirectory: ${{ parameters.ServiceDirectory }}
+          PipelineArtifactName: packages
           Artifacts: ${{ parameters.Artifacts }}
-          ${{ if eq(parameters.ServiceDirectory, 'template') }}:
-            TestPipeline: true
+          TestPipeline: ${{ eq(parameters.ServiceDirectory, 'template') }}
           TestTimeoutInMinutes: ${{ parameters.TestTimeoutInMinutes }}
-          PipelineArtifactName: packages
+          TestProxy: ${{ parameters.TestProxy }}
+          MatrixConfigs:
+          - ${{ each config in parameters.MatrixConfigs }}:
+            - ${{ config }}
+          - ${{ each config in parameters.AdditionalMatrixConfigs }}:
+            - ${{ config }}
+          MatrixFilters: ${{ parameters.MatrixFilters }}
+          MatrixReplace: ${{ parameters.MatrixReplace }}
 
     - template: archetype-rust-release.yml
       parameters:
         DependsOn: "Build"
         ServiceDirectory: ${{ parameters.ServiceDirectory }}
         Artifacts: ${{ parameters.Artifacts }}
-        ${{ if eq(parameters.ServiceDirectory, 'template') }}:
-          TestPipeline: true
+        TestPipeline: ${{ eq(parameters.ServiceDirectory, 'template') }}
         PipelineArtifactName: packages

eng/pipelines/templates/stages/platform-matrix.json

@@ -0,0 +1,25 @@
+{
+  "displayNames": {},
+  "matrix": {
+    "Agent": {
+      "ubuntu": {
+        "OSVmImage": "env:LINUXVMIMAGE",
+        "Pool": "env:LINUXPOOL"
+      },
+      "windows": {
+        "OSVmImage": "env:WINDOWSVMIMAGE",
+        "Pool": "env:WINDOWSPOOL"
+      },
+      "macos": {
+        "OSVmImage": "env:MACVMIMAGE",
+        "Pool": "env:MACPOOL"
+      }
+    },
+    "RustToolchainName": [
+      "stable",
+      "msrv",
+      "nightly"
+    ]
+  },
+  "include": []
+}