Autopublish + Artefacts on Error (#3)

New Features Autopublish artefacts When test pipeline fails, due to failing tests, artefacts are still generated Workflow now uses local action for easier testing Added test for upload-artifact: false Changes Bash cleanup .NET 6.0
cryptic-wizard · Jul 30, 2022 · 60ce868 · 60ce868
1 parent 0d1ca02
commit 60ce868
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 66 deletions.
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -1,4 +1,4 @@
-name: .NET 5.0
+name: .NET 6.0
 on:
   push:
 
@@ -13,17 +13,11 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 5.0.x
-    - uses:  cryptic-wizard/run-specflow-tests@v1.2.0
+        dotnet-version: 6.0.x
+    - uses:  ./
       with:
-        test-assembly-path: RunSpecflowTests/bin/Release/net5.0
+        test-assembly-path: RunSpecflowTests/bin/Release/net6.0
         test-assembly-dll: RunSpecflowTests.dll
         test-execution-json: TestExecution.json
         output-html: CalculatorResults.html
-        framework: net5.0
-    - name: Publish Specflow Test Results
-      if: success() || failure()
-      uses: actions/upload-artifact@v2
-      with:
-        name: SpecflowTestResults
-        path: CalculatorResults.html
+        framework: net6.0
diff --git a/.github/workflows/dotnetcore.yml b/.github/workflows/dotnetcore.yml
@@ -14,7 +14,7 @@ jobs:
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: 3.1.x
-    - uses:  cryptic-wizard/run-specflow-tests@v1.2.0
+    - uses:  ./
       with:
         test-assembly-dll: RunSpecflowTests/bin/Debug/netcoreapp3.1/RunSpecflowTests.dll
         test-execution-json: RunSpecflowTests/bin/Debug/netcoreapp3.1/TestExecution.json
@@ -23,11 +23,10 @@ jobs:
         configuration: 'Debug'
         logger: trx
         logger-file-name: ../../CalculatorResults.trx
-    - name: Publish Specflow Test Results
+    - name: Publish Specflow Test Logs
       if: success() || failure()
       uses: actions/upload-artifact@v2
       with:
-        name: SpecflowTestResults
+        name: SpecflowLogs
         path: |
-          CalculatorResults.html
-          CalculatorResults.trx
+          CalculatorResults.trx
diff --git a/.github/workflows/dotnetnoartifacts.yml b/.github/workflows/dotnetnoartifacts.yml
@@ -0,0 +1,24 @@
+name: .NET 6.0 No Artifacts
+on:
+  push:
+
+jobs:
+  build:
+    name: Build & Test
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 6.0.x
+    - uses:  ./
+      with:
+        test-assembly-path: RunSpecflowTests/bin/Release/net6.0
+        test-assembly-dll: RunSpecflowTests.dll
+        test-execution-json: TestExecution.json
+        output-html: CalculatorResults.html
+        framework: net6.0
+        upload-artifact: false
diff --git a/README.md b/README.md
@@ -27,11 +27,6 @@ steps:
     test-assembly-dll: MySpecflowProject.dll
     test-execution-json: TestExecution.json
     output-html: MyTestResults.html
- - uses: actions/upload-artifact@v2
-  if: success() || failure()
-  with:
-    name: SpecflowTestResults
-    path: MyTestResults.html
 ```
 
 #### Test Multiple Operating Systems in the Same Workflow:
@@ -55,11 +50,6 @@ jobs:
       test-assembly-dll: MySpecflowProject.dll
       test-execution-json: TestExecution.json
       output-html: ${{ matrix.os }}.html
-  - uses: actions/upload-artifact@v2
-    if: success() || failure()
-    with:
-      name: SpecflowTestResults
-      path: ${{ matrix.os }}.html
 ```
 
 #### Test Multiple Frameworks in Separate Workflows:
@@ -112,7 +102,6 @@ logger-file-name:
 Features planned when ['uses' keyword is implemented in composite actions](https://github.com/actions/runner/issues/646)
 * Checkout automatically
 * Setup dotnet automatically
-* Upload artifacts automatically
 * Dotnet framework matrix testing
 ## Tools
 * [Visual Studio](https://visualstudio.microsoft.com/vs/)

diff --git a/RunSpecflowTests/RunSpecflowTests.csproj b/RunSpecflowTests/RunSpecflowTests.csproj
@@ -1,12 +1,12 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net5.0</TargetFrameworks>
+    <TargetFrameworks>netcoreapp3.1;net6.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
-    <PackageReference Include="SpecFlow.Plus.LivingDocPlugin" Version="3.9.50" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
+    <PackageReference Include="SpecFlow.Plus.LivingDocPlugin" Version="3.9.57" />
     <PackageReference Include="SpecFlow.NUnit" Version="3.9.22" />
     <PackageReference Include="nunit" Version="3.13.2" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.0.0" />

diff --git a/action.yml b/action.yml
@@ -48,52 +48,54 @@ inputs:
     description: "Dotnet test log file name; required if logger is defined (example: MyTestResults.trx)"
     required: false
     default: 'null'
-  #upload-artifact: TODO on composite action 'uses'
-    #description: "Set to false to disable uploading <LivingDoc.html> artifact automatically"
-    #required: false
-    #default: 'true'
+  upload-artifact:
+    description: "Set to false to disable uploading <LivingDoc.html> artifact automatically"
+    required: false
+    default: 'true'
 runs:
   using: composite
   steps:
-    #- name: Checkout TODO on composite action 'uses'
-      #uses: actions/checkout@v2
-    #- name: Setup .NET Core
-      #uses: actions/setup-dotnet@v1
-      #with:
-        #dotnet-version: 3.1.x
     - name: BuildDotnetApp
       run: |
-        if [ ${{ inputs.no-build }} == 'true' ]; then
-          echo 'Build Skipped'
-        elif [ ${{ inputs.framework }} == 'null' ]; then
-          dotnet build -c ${{ inputs.configuration }} -v ${{ inputs.build-verbosity }}
-        else
-          dotnet build -c ${{ inputs.configuration }} -v ${{ inputs.build-verbosity }} -f ${{ inputs.framework }}
-        fi
+        _args=()
+        [ "${{ inputs.configuration }}" != 'null' ] && _args+=("-c" "${{ inputs.configuration }}")
+        [ "${{ inputs.build-verbosity }}" != 'null' ] && _args+=("-v" "${{ inputs.build-verbosity }}")
+        [ "${{ inputs.framework }}" != 'null' ] && _args+=("-f" "${{ inputs.framework }}")
+
+        [ ${{ inputs.no-build }} == 'true' ] && echo 'Build Skipped' || dotnet build "${_args[@]}"
       shell: bash
     - name: RunSpecFlowTests
       run: |
-        if   [ ${{ inputs.logger }} == 'null' ] || [ ${{ inputs.logger-file-name }} == 'null' ] && [ ${{ inputs.framework }} == 'null' ]; then
-          dotnet test --no-build -c ${{ inputs.configuration }} -v ${{ inputs.test-verbosity }}
-        elif [ ${{ inputs.logger }} == 'null' ] || [ ${{ inputs.logger-file-name }} == 'null' ]; then
-          dotnet test --no-build -c ${{ inputs.configuration }} -v ${{ inputs.test-verbosity }} -f ${{ inputs.framework }}
-        elif [ ${{ inputs.framework }} == 'null' ]; then
-          dotnet test --no-build -c ${{ inputs.configuration }} -v ${{ inputs.test-verbosity }} -l "${{ inputs.logger }};verbosity=${{ inputs.test-verbosity }};LogFileName=${{ inputs.logger-file-name }}"
-        else
-          dotnet test --no-build -c ${{ inputs.configuration }} -v ${{ inputs.test-verbosity }} -f ${{ inputs.framework }} -l "${{ inputs.logger }};verbosity=${{ inputs.test-verbosity }};LogFileName=${{ inputs.logger-file-name }}"
+        _args=()
+        _logger_args=()
+        [ "${{ inputs.configuration }}" != 'null' ] && _args+=("-c" "${{ inputs.configuration }}")
+        [ "${{ inputs.build-verbosity }}" != 'null' ] && _args+=("-v" "${{ inputs.build-verbosity }}")
+        [ "${{ inputs.framework }}" != 'null' ] && _args+=("-f" "${{ inputs.framework }}")
+        [ "${{ inputs.test-verbosity }}" != 'null' ] && _logger_args+=(";verbosity=${{ inputs.test-verbosity }}")
+        [ "${{ inputs.logger-file-name }}" != 'null' ] && _logger_args+=(";LogFileName=${{ inputs.logger-file-name }}")
+        [ "${{ inputs.logger }}" != 'null' ] && _args+=("-l" "${{ inputs.logger }}$(IFS=; echo "${_logger_args[@]}")")
+        
+        if ! dotnet test --no-build "${_args[@]}"; then
+            echo "_EXIT=1" >> $GITHUB_ENV
         fi
       shell: bash
-    - name: GenerateSpecFlowLivingDoc
+      continue-on-error: true
+    - name: GenerateLivingSpec
       run: |
+        [ "${{ inputs.test-assembly-path }}" != 'null' ] && _path="${{ inputs.test-assembly-path }}"
+        _dll="${_path:+$_path/}${{ inputs.test-assembly-dll }}"
+        _test="${_path:+$_path/}${{ inputs.test-execution-json }}"
+
         dotnet tool install --global SpecFlow.Plus.LivingDoc.CLI
-        if [ ${{ inputs.test-assembly-path }} != 'null' ]; then
-          livingdoc test-assembly ${{ inputs.test-assembly-path }}/${{ inputs.test-assembly-dll }} -t ${{ inputs.test-assembly-path }}/${{ inputs.test-execution-json }} -o ${{ inputs.output-html }}
-        else
-          livingdoc test-assembly ${{ inputs.test-assembly-dll }} -t ${{ inputs.test-execution-json }} -o ${{ inputs.output-html }}
-        fi
+        livingdoc test-assembly "$_dll" -t "$_test" -o "${{ inputs.output-html }}"
+      shell: bash
+    - name: 'Publish Specflow Test Results'
+      if: ${{ inputs.upload-artifact == 'true' }}
+      uses: actions/upload-artifact@v2
+      with:
+        name: 'Specflow Test Results'
+        path: ${{ inputs.output-html }}
+    - name: ReturnCode
+      run: |
+        echo "${_EXIT:-0}"
       shell: bash
-    #- name: 'Publish Specflow Test Results'
-      #uses: actions/upload-artifact@v2
-      #with:
-        #name: 'Specflow Test Results'
-        #path: ${{ output-html }}