mxlint-cli/.github/workflows/ci.yml at main · mxlint/mxlint-cli · GitHub

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
204
205
206
207
208
209
name: Continuous Integration

on:
  push:
    branches:
    - "*"
  pull_request:
    types: [opened, reopened, synchronize]
    branches: [ main ]

jobs:
  unit_tests:
    name: "Unit tests"
    permissions:
      contents: read
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Setup Go
      uses: actions/setup-go@v4
      with:
        go-version: ^1.22

    - name: Test
      run: go test -cover -coverprofile=coverage.txt ./...

    - name: Archive code coverage results
      uses: actions/upload-artifact@v4
      with:
        name: code-coverage
        path: coverage.txt

    - name: Generate coverage HTML report
      run: go tool cover -html=coverage.txt -o coverage.html

    - name: Upload coverage HTML report artifact
      uses: actions/upload-artifact@v4
      with:
        name: coverage-report
        path: coverage.html

  code_coverage:
    name: "Code coverage report"
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    needs: unit_tests
    permissions:
      contents:      read
      actions:       read
      pull-requests: write
    steps:
    - uses: fgrosse/go-coverage-report@v1.1.1
      with:
        coverage-artifact-name: "code-coverage"
        coverage-file-name: "coverage.txt"

  build_cli:
    name: "Build CLI"
    permissions:
      contents: read
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Set up Go
      uses: actions/setup-go@v5
      with:
        go-version: ^1.22

    - name: Build
      run: go build -o bin/mxlint "./"

    - name: Archive mxlint binary
      uses: actions/upload-artifact@v4
      with:
        name: mxlint-cli
        path: bin

  test_export_model_v1:
    name: "Test export mpr-v1"
    permissions:
      contents: read
    needs: build_cli
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Download mxlint binary
      uses: actions/download-artifact@v4
      with:
        name: mxlint-cli
        path: bin

    - name: Test subcommand export mpr-v1
      run: |
        chmod +x ./bin/mxlint
        mkdir -p .ci
        cat > .ci/export-v1.yaml << 'EOF'
        projectDirectory: resources/app-mpr-v1
        modelsource: resources/modelsource-v1
        export:
          filter: ".*"
          raw: false
          appstore: false
        EOF
        ./bin/mxlint --config .ci/export-v1.yaml export
        git diff --exit-code resources/modelsource-v1

  test_export_model_v2:
    name: "Test export mpr-v2"
    permissions:
      contents: read
    needs: build_cli
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Download mxlint binary
      uses: actions/download-artifact@v4
      with:
        name: mxlint-cli
        path: bin

    - name: Test subcommand export mpr-v2
      run: |
        chmod +x ./bin/mxlint
        mkdir -p .ci
        cat > .ci/export-v2.yaml << 'EOF'
        projectDirectory: resources/app-mpr-v2
        modelsource: resources/modelsource-v2
        export:
          filter: ".*"
          raw: false
          appstore: false
        EOF
        ./bin/mxlint --config .ci/export-v2.yaml export
        git diff --exit-code resources/modelsource-v2

  test_lint:
    name: "Test lint"
    permissions:
      contents: read
    needs: build_cli
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Download mxlint binary
      uses: actions/download-artifact@v4
      with:
        name: mxlint-cli
        path: bin

    - name: Test subcommand lint
      run: |
        chmod +x ./bin/mxlint
        mkdir -p .ci
        cat > .ci/lint.yaml << 'EOF'
        rules:
          path: ./resources/rules
        modelsource: resources/modelsource-v1
        lint:
          xunitReport: report.xml
          skip:
            MyFirstModule/DomainModels$DomainModel:
              - rule: "002_0009"
                reason: CI fixture intentionally keeps a default value for rule coverage
            MyFirstModule/Home_Web.Forms$Page:
              - rule: "004_0001"
                reason: CI fixture intentionally uses inline style for rule coverage
              - rule: "004_0004"
                reason: CI fixture intentionally has heading order issue for rule coverage
            MyFirstModule/BadPage.Forms$Page:
              - rule: "004_0002"
                reason: CI fixture intentionally omits image alt text for rule coverage
              - rule: "004_0003"
                reason: CI fixture intentionally uses multiple h1 tags for rule coverage
              - rule: "004_0004"
                reason: CI fixture intentionally has heading order issue for rule coverage
        EOF
        ./bin/mxlint --config .ci/lint.yaml lint


  test_rules:
    name: "Test rules"
    permissions:
      contents: read
    needs: build_cli
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Download mxlint binary
      uses: actions/download-artifact@v4
      with:
        name: mxlint-cli
        path: bin

    - name: Test subcommand test-rules
      run: |
        chmod +x ./bin/mxlint
        mkdir -p .ci
        cat > .ci/test-rules.yaml << 'EOF'
        rules:
          path: ./resources/rules
        EOF
        ./bin/mxlint --config .ci/test-rules.yaml test-rules