summaryrefslogtreecommitdiff
path: root/azure-pipelines.yml
blob: 1829cdec253362a499b337d5774ef7297d36ab0b (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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# Mutilated beyond recognition from the example at:
# https://docs.microsoft.com/azure/devops/pipelines/languages/go

trigger:
  - v2

schedules:
- cron: "0 0 * * *"
  displayName: Daily midnight fuzzing
  branches:
    include:
    - v2
  always: true

variables:
  GOROOT: $(gorootDir)/go
  GOPATH: $(system.defaultWorkingDirectory)/gopath
  GOBIN:  $(GOPATH)/bin
  modulePath: '$(GOPATH)/src/github.com/$(build.repository.name)'

jobs:
- job: crossPlatformTest
  displayName: "Cross-Platform Tests"
  strategy:
    matrix:
      linux:
        imageName: ubuntu-16.04
        gorootDir: /usr/local
      mac:
        imageName: macos-10.14
        gorootDir: /usr/local
      windows:
        imageName: windows-2019
        gorootDir: C:\
  pool:
    vmImage: $(imageName)
  
  steps:
  - bash: |
      latestGo=$(curl "https://golang.org/VERSION?m=text")
      echo "##vso[task.setvariable variable=LATEST_GO]$latestGo"
      echo "Latest Go version: $latestGo"
    displayName: "Get latest Go version"

  - bash: |
      sudo rm -f $(which go)
      echo '##vso[task.prependpath]$(GOBIN)'
      echo '##vso[task.prependpath]$(GOROOT)/bin'
      mkdir -p '$(modulePath)'
      shopt -s extglob
      shopt -s dotglob
      mv !(gopath) '$(modulePath)'
    displayName: Remove old Go, set GOBIN/GOROOT, and move project into GOPATH

  # Install Go (this varies by platform)
  - bash: |
      wget "https://dl.google.com/go/$(LATEST_GO).linux-amd64.tar.gz"
      sudo tar -C $(gorootDir) -xzf "$(LATEST_GO).linux-amd64.tar.gz"
    condition: eq( variables['Agent.OS'], 'Linux' )
    displayName: Install Go on Linux

  - bash: |
      wget "https://dl.google.com/go/$(LATEST_GO).darwin-amd64.tar.gz"
      sudo tar -C $(gorootDir) -xzf "$(LATEST_GO).darwin-amd64.tar.gz"
    condition: eq( variables['Agent.OS'], 'Darwin' )
    displayName: Install Go on macOS

  # The low performance is partly due to PowerShell's attempt to update the progress bar. Disabling it speeds up the process.
  # Reference: https://github.com/PowerShell/PowerShell/issues/2138
  - powershell: |
      $ProgressPreference = 'SilentlyContinue'
      Write-Host "Downloading Go..."
      (New-Object System.Net.WebClient).DownloadFile("https://dl.google.com/go/$(LATEST_GO).windows-amd64.zip", "$(LATEST_GO).windows-amd64.zip")
      Write-Host "Extracting Go... (I'm slow too)"
      7z x "$(LATEST_GO).windows-amd64.zip" -o"$(gorootDir)"
    condition: eq( variables['Agent.OS'], 'Windows_NT' )
    displayName: Install Go on Windows

  - bash: curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.23.6
    displayName: Install golangci-lint

  - script: |
      go get github.com/axw/gocov/gocov
      go get github.com/AlekSi/gocov-xml
      go get -u github.com/jstemmer/go-junit-report
    displayName: Install test and coverage analysis tools

  - bash: |
      printf "Using go at: $(which go)\n"
      printf "Go version: $(go version)\n"
      printf "\n\nGo environment:\n\n"
      go env
      printf "\n\nSystem environment:\n\n"
      env
    displayName: Print Go version and environment

  - script: |
      go get -v -t -d ./...
      mkdir test-results
    workingDirectory: '$(modulePath)'
    displayName: Get dependencies

  - bash: CGO_ENABLED=0 go build -trimpath -a -ldflags="-w -s" -v
    workingDirectory: '$(modulePath)/cmd/caddy'
    displayName: Build Caddy

  - task: PublishBuildArtifacts@1
    condition: eq( variables['Agent.OS'], 'Windows_NT' )
    inputs:
      pathtoPublish: '$(modulePath)/cmd/caddy/caddy.exe'
      artifactName: caddy_v2.exe

  - task: PublishBuildArtifacts@1
    condition: ne( variables['Agent.OS'], 'Windows_NT' )
    inputs:
      pathtoPublish: '$(modulePath)/cmd/caddy/caddy'
      artifactName: 'caddy_v2_$(Agent.OS)'

  # its behavior is governed by .golangci.yml
  - script: |
      (golangci-lint run --out-format junit-xml) > test-results/lint-result.xml
      exit 0
    workingDirectory: '$(modulePath)'
    continueOnError: true
    displayName: Run lint check

  - script: |
      (go test -v -coverprofile=cover-profile.out -race ./... 2>&1) > test-results/test-result.out
    workingDirectory: '$(modulePath)'
    continueOnError: true
    displayName: Run tests

  - script: |
      set -e
      cmd/caddy/caddy start
      go test -v -count=1 ./caddytest/...
      cmd/caddy/caddy stop
    workingDirectory: '$(modulePath)'
    continueOnError: false
    displayName: Run Integration tests

  - script: |
      mkdir coverage
      gocov convert cover-profile.out > coverage/coverage.json
      # Because Windows doesn't work with input redirection like *nix, but output redirection works.
      (cat ./coverage/coverage.json | gocov-xml) > coverage/coverage.xml 
    workingDirectory: '$(modulePath)'
    displayName: Prepare coverage reports

  - script: |
      (cat ./test-results/test-result.out | go-junit-report) > test-results/test-result.xml
    workingDirectory: '$(modulePath)'
    displayName: Prepare test report

  - task: PublishCodeCoverageResults@1
    displayName: Publish test coverage report
    inputs:
      codeCoverageTool: Cobertura 
      summaryFileLocation: $(modulePath)/coverage/coverage.xml

  - task: PublishTestResults@2
    displayName: Publish unit test
    inputs:
      testResultsFormat: 'JUnit'
      testResultsFiles: $(modulePath)/test-results/test-result.xml
      testRunTitle: $(agent.OS) Unit Test
      mergeTestResults: false

  - task: PublishTestResults@2
    displayName: Publish lint results
    inputs:
      testResultsFormat: 'JUnit'
      testResultsFiles: $(modulePath)/test-results/lint-result.xml
      testRunTitle: $(agent.OS) Lint
      mergeTestResults: false

  - bash: |
      exit 1
    condition: eq(variables['Agent.JobStatus'], 'SucceededWithIssues')
    displayName: Coerce correct build result

- job: fuzzing
  displayName: 'Fuzzing'
  # Only run this job on schedules or PRs for non-forks.
  condition: or(eq(variables['System.PullRequest.IsFork'], 'False'), eq(variables['Build.Reason'], 'Schedule') )
  strategy:
    matrix:
      linux:
        imageName: ubuntu-16.04
        gorootDir: /usr/local
  pool:
    vmImage: $(imageName)

  steps:
  - bash: |
      latestGo=$(curl "https://golang.org/VERSION?m=text")
      echo "##vso[task.setvariable variable=LATEST_GO]$latestGo"
      echo "Latest Go version: $latestGo"
    displayName: "Get latest Go version"

  - bash: |
      sudo rm -f $(which go)
      echo '##vso[task.prependpath]$(GOBIN)'
      echo '##vso[task.prependpath]$(GOROOT)/bin'
      mkdir -p '$(modulePath)'
      shopt -s extglob
      shopt -s dotglob
      mv !(gopath) '$(modulePath)'
    displayName: Remove old Go, set GOBIN/GOROOT, and move project into GOPATH

  - bash: |
      wget "https://dl.google.com/go/$(LATEST_GO).linux-amd64.tar.gz"
      sudo tar -C $(gorootDir) -xzf "$(LATEST_GO).linux-amd64.tar.gz"
    condition: eq( variables['Agent.OS'], 'Linux' )
    displayName: Install Go on Linux

  - bash: |
      # Install Clang-7.0 because other versions seem to be missing the file libclang_rt.fuzzer-x86_64.a
      sudo add-apt-repository "deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-7 main"
      wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
      sudo apt update && sudo apt install -y clang-7 lldb-7 lld-7

      go get -v github.com/dvyukov/go-fuzz/go-fuzz github.com/dvyukov/go-fuzz/go-fuzz-build
      wget -q -O fuzzit https://github.com/fuzzitdev/fuzzit/releases/download/v2.4.77/fuzzit_Linux_x86_64
      chmod a+x fuzzit
      mv fuzzit $(GOBIN)
    displayName: Download go-fuzz tools and the Fuzzit CLI, and move Fuzzit CLI to GOBIN
    condition: and(eq(variables['System.PullRequest.IsFork'], 'False') , eq( variables['Agent.OS'], 'Linux' ))

  - bash: |
      declare -A fuzzers_funcs=(\
        ["./caddyconfig/httpcaddyfile/addresses_fuzz.go"]="FuzzParseAddress" \
        ["./caddyconfig/caddyfile/parse_fuzz.go"]="FuzzParseCaddyfile" \
        ["./listeners_fuzz.go"]="FuzzParseNetworkAddress" \
        ["./replacer_fuzz.go"]="FuzzReplacer" \
      )

      declare -A fuzzers_targets=(\
        ["./caddyconfig/httpcaddyfile/addresses_fuzz.go"]="parse-address" \
        ["./caddyconfig/caddyfile/parse_fuzz.go"]="parse-caddyfile" \
        ["./listeners_fuzz.go"]="parse-network-address" \
        ["./replacer_fuzz.go"]="replacer" \
      )

      fuzz_type="local-regression"
      if [[ $(Build.Reason) == "Schedule" ]]; then
        fuzz_type="fuzzing"
      fi
      echo "Fuzzing type: $fuzz_type"

      for f in $(find . -name \*_fuzz.go); do
        FUZZER_DIRECTORY=$(dirname $f)
        echo "go-fuzz-build func ${fuzzers_funcs[$f]} residing in $f"
        go-fuzz-build -func "${fuzzers_funcs[$f]}" -libfuzzer -o "$FUZZER_DIRECTORY/${fuzzers_targets[$f]}.a" $FUZZER_DIRECTORY
        echo "Generating fuzzer binary of func ${fuzzers_funcs[$f]} which resides in $f"
        clang-7 -fsanitize=fuzzer "$FUZZER_DIRECTORY/${fuzzers_targets[$f]}.a" -o "$FUZZER_DIRECTORY/${fuzzers_targets[$f]}"
        fuzzit create job caddyserver/${fuzzers_targets[$f]} $FUZZER_DIRECTORY/${fuzzers_targets[$f]} --api-key ${FUZZIT_API_KEY} --type "${fuzz_type}" --branch "${SYSTEM_PULLREQUEST_SOURCEBRANCH}" --revision "${BUILD_SOURCEVERSION}"
        echo "Completed $f"
      done
    env:
      FUZZIT_API_KEY: $(FUZZIT_API_KEY)
    workingDirectory: '$(modulePath)'
    displayName: Generate fuzzers & submit them to Fuzzit