summaryrefslogtreecommitdiff
path: root/.github/workflows/regression_template.yml
blob: 205eb5a8cb3be774af9f66b56561028fd6862171 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# This is a basic workflow that is manually triggered

name: regression_template

on:
  workflow_call:
    inputs:
      install_script:
        default: './scripts/install.sh'
        required: false
        type: string
      build_script:
        default: './scripts/build.sh'
        required: false
        type: string
      test_script:
        default: './scripts/test.sh'
        required: false
        type: string
      cmake_path:
        default: './test/cmake'
        required: false
        type: string
      skip_test:
        default: false
        required: false
        type: boolean
      skip_coverage:
        default: false
        required: false
        type: boolean
      coverage_name:
        default: 'default_build_coverage'
        required: false
        type: string
      skip_deploy:
        default: false
        required: false
        type: boolean
      deploy_list:
        default: ''
        required: false
        type: string
      result_affix:
        default: ''
        required: false
        type: string

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "linux_job"
  run_tests:
    if: ${{ !inputs.skip_test}}
    permissions:
      contents: read
      issues: read
      checks: write
      pull-requests: write

    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
    - name: Check out the repository
      uses: actions/[email protected]
      with:
        submodules: true

    - name: Install softwares
      run: ${{ inputs.install_script }}

    - name: Build
      run: ${{ inputs.build_script }}

    - name: Test
      run: ${{ inputs.test_script }}

    - name: Publish Test Results
      uses: EnricoMi/[email protected]
      if: always()
      with:
        check_name: Test Results ${{ inputs.result_affix }}
        files: |
          ${{ inputs.cmake_path }}/build/*/*.xml

    - name: Upload Test Results
      if: success() || failure()
      uses: actions/[email protected]
      with:
        name: test_reports ${{ inputs.result_affix }}
        path: |
          ${{ inputs.cmake_path }}/build/*.txt
          ${{ inputs.cmake_path }}/build/*/Testing/**/*.xml
          ${{ inputs.cmake_path }}/build/**/regression/output_files/*.bin

    - name: Configure GitHub Pages
      uses: actions/[email protected]

    - name: Generate Code Coverage Results Summary
      if: (!inputs.skip_coverage)
      uses: irongut/[email protected]
      with:
        filename: ${{ inputs.cmake_path }}/coverage_report/${{ inputs.coverage_name }}.xml
        format: markdown
        badge: true
        hide_complexity: true
        output: file

    - name: Write Code Coverage Summary
      if: (!inputs.skip_coverage)
      run: |
        echo "## Coverage Report ${{ inputs.result_affix }}" >> $GITHUB_STEP_SUMMARY
        cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY

    - name: Create CheckRun for Code Coverage
      if: ((github.event_name == 'push') || (github.event_name == 'workflow_dispatch') || (github.event.pull_request.head.repo.full_name == github.repository)) && (!inputs.skip_coverage)
      uses: LouisBrunner/[email protected]
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        name: Code Coverage ${{ inputs.result_affix }}
        conclusion: ${{ job.status }}
        output: |
          {"summary":"Coverage Report"}
        output_text_description_file: code-coverage-results.md

    - name: Add Code Coverage PR Comment
      if: ((github.event_name == 'push') || (github.event.pull_request.head.repo.full_name == github.repository)) && (!inputs.skip_coverage)
      uses: marocchino/[email protected]
      with:
        header: Code Coverage ${{ inputs.result_affix }}
        path: code-coverage-results.md

    # Add sudo to move coverage folder created by root user
    - name: Prepare Coverage GitHub Pages
      if: (!inputs.skip_coverage)
      run: >-
        if [ "${{ inputs.result_affix }}" != "" ] && ${{ inputs.skip_deploy }}; then
          sudo mv ${{ inputs.cmake_path }}/coverage_report/${{ inputs.coverage_name }} \
            ${{ inputs.cmake_path }}/coverage_report/${{ inputs.result_affix }}
        fi

    - name: Coverage Report name
      id: artifact
      if: (!inputs.skip_coverage)
      run: echo "coverage_report=coverage_report-$(date +%s)" >> $GITHUB_OUTPUT

    - name: Upload Code Coverage Artifacts
      uses: actions/[email protected]
      if: (inputs.skip_deploy && !inputs.skip_coverage)
      with:
          name: ${{ steps.artifact.outputs.coverage_report }}
          path: ${{ inputs.cmake_path }}/coverage_report
          retention-days: 1

    - name: Upload Code Coverage Pages
      uses: actions/[email protected]
      if: (!inputs.skip_deploy && !inputs.skip_coverage)
      with:
        path: ${{ inputs.cmake_path }}/coverage_report/${{ inputs.coverage_name }}

  deploy_code_coverage:
    runs-on: ubuntu-latest
    if: ((github.event_name == 'push') || (github.event_name == 'workflow_dispatch')) && !inputs.skip_coverage && !inputs.skip_deploy && !failure() && !cancelled()
    needs: run_tests
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      pages: write
      id-token: write

    steps:
    - uses: actions/[email protected]
      if: ${{ inputs.skip_test }}
      with:
        name: ${{ steps.artifact.outputs.coverage_report }}
        path: ${{ inputs.cmake_path }}/coverage_report

    - name: Upload Code Coverage Pages
      uses: actions/[email protected]
      if: ${{ inputs.skip_test }}
      with:
        path: .

    - name: Delete Duplicate Code Coverage Artifact
      uses: geekyeggo/[email protected]
      with:
          name: coverage_report

    - name: Deploy GitHub Pages site
      id: deployment
      uses: actions/[email protected]

    - name: Write Code Coverage Report URL
      run: >-
        if [ "${{ inputs.deploy_list }}" != "" ]; then
          for i in ${{ inputs.deploy_list }}; do
            echo 'Coverage report for ' $i ':${{ steps.deployment.outputs.page_url }}'$i >>  $GITHUB_STEP_SUMMARY
          done
        else
          echo 'Coverage report: ${{ steps.deployment.outputs.page_url }}' >>  $GITHUB_STEP_SUMMARY
        fi