.gitlab-ci.yml 14.7 KB
Newer Older
Denis_P's avatar
Denis_P committed
1
2
3
4
5
6
7
8
# .gitlab-ci.yml
#
# ink
#
# pipelines can be triggered manually in the web


stages:
Denis_P's avatar
Denis_P committed
9
10
  - check
  - workspace
Denis_P's avatar
Denis_P committed
11
  - examples
12
  - fuzz
13
  - publish
Denis_P's avatar
Denis_P committed
14
15
16

variables:
  GIT_STRATEGY:                    fetch
Denis_P's avatar
Denis_P committed
17
  GIT_DEPTH:                       100
18
  CARGO_INCREMENTAL:               0
Denis_P's avatar
Denis_P committed
19
  CARGO_TARGET_DIR:                "/ci-cache/${CI_PROJECT_NAME}/targets/${CI_COMMIT_REF_NAME}/${CI_JOB_NAME}"
Denis_P's avatar
Denis_P committed
20
  CI_IMAGE:                        "paritytech/ink-ci-linux:production"
21
22
  PURELY_STD_CRATES:               "lang/codegen metadata"
  ALSO_WASM_CRATES:                "env storage storage/derive allocator prelude primitives lang lang/macro lang/ir"
Denis_P's avatar
Denis_P committed
23
24
  # this var is changed to "-:staging" when the CI image gets rebuilt
  # read more https://github.com/paritytech/scripts/pull/244
Michael Müller's avatar
Michael Müller committed
25
  ALL_CRATES:                      "${PURELY_STD_CRATES} ${ALSO_WASM_CRATES}"
26
  DELEGATOR_SUBCONTRACTS:           "accumulator adder subber"
Denis_P's avatar
Denis_P committed
27

28
29
30
31
32
workflow:
  rules:
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_BRANCH

Denis_P's avatar
Denis_P committed
33
34
35
36
37
38
39
40
41
.collect-artifacts:                &collect-artifacts
  artifacts:
    name:                          "${CI_JOB_NAME}_${CI_COMMIT_REF_NAME}"
    when:                          on_success
    expire_in:                     7 days
    paths:
      - artifacts/

.docker-env:                       &docker-env
Denis_P's avatar
Denis_P committed
42
  image:                           "${CI_IMAGE}"
Denis_P's avatar
Denis_P committed
43
  before_script:
Denis_P's avatar
Denis_P committed
44
45
    - cargo -vV
    - rustc -vV
Denis_P's avatar
Denis_P committed
46
    - rustup show
Denis_P's avatar
Denis_P committed
47
    - bash --version
Denis_P's avatar
Denis_P committed
48
    - ./scripts/pre_cache.sh
Denis_P's avatar
Denis_P committed
49
    - sccache -s
50
51
52
53
54
  rules:
    - if: $CI_PIPELINE_SOURCE == "web"
    - if: $CI_PIPELINE_SOURCE == "schedule"
    - if: $CI_COMMIT_REF_NAME == "master"
    - if: $CI_COMMIT_REF_NAME == "tags"
Denis_P's avatar
Denis_P committed
55
    - if: $CI_COMMIT_REF_NAME =~ /^[0-9]+$/                         # PRs
56
    - if: $CI_COMMIT_REF_NAME =~ /^v[0-9]+\.[0-9]+.*$/              # i.e. v1.0, v2.1rc1
Denis_P's avatar
Denis_P committed
57
  interruptible:                   true
58
59
  retry:
    max: 2
Denis_P's avatar
Denis_P committed
60
    when:
61
62
63
      - runner_system_failure
      - unknown_failure
      - api_failure
Denis_P's avatar
Denis_P committed
64
  tags:
65
    - linux-docker
Denis_P's avatar
Denis_P committed
66

Denis_P's avatar
Denis_P committed
67
68

#### stage:                        check
Denis_P's avatar
Denis_P committed
69

Hero Bird's avatar
Hero Bird committed
70
check-std:
Denis_P's avatar
Denis_P committed
71
  stage:                           check
Denis_P's avatar
Denis_P committed
72
73
  <<:                              *docker-env
  script:
Hero Bird's avatar
Hero Bird committed
74
    - for crate in ${ALL_CRATES}; do
75
        cargo check --verbose --all-features --manifest-path crates/${crate}/Cargo.toml;
Hero Bird's avatar
Hero Bird committed
76
      done
Denis_P's avatar
Denis_P committed
77

Hero Bird's avatar
Hero Bird committed
78
check-wasm:
Denis_P's avatar
Denis_P committed
79
  stage:                           check
Denis_P's avatar
Denis_P committed
80
81
  <<:                              *docker-env
  script:
82
    - for crate in ${ALSO_WASM_CRATES}; do
83
        cargo check --verbose --no-default-features --target wasm32-unknown-unknown --manifest-path crates/${crate}/Cargo.toml;
Hero Bird's avatar
Hero Bird committed
84
      done
Denis_P's avatar
Denis_P committed
85

86

Denis_P's avatar
Denis_P committed
87
88
#### stage:                        workspace

Hero Bird's avatar
Hero Bird committed
89
build-std:
Denis_P's avatar
Denis_P committed
90
  stage:                           workspace
Denis_P's avatar
Denis_P committed
91
  <<:                              *docker-env
Denis_P's avatar
Denis_P committed
92
  needs:
93
94
    - job:                         check-std
      artifacts:                   false
Denis_P's avatar
Denis_P committed
95
  script:
Hero Bird's avatar
Hero Bird committed
96
    - for crate in ${ALL_CRATES}; do
97
        cargo build --verbose --all-features --release --manifest-path crates/${crate}/Cargo.toml;
Hero Bird's avatar
Hero Bird committed
98
      done
Denis_P's avatar
Denis_P committed
99

Hero Bird's avatar
Hero Bird committed
100
build-wasm:
Denis_P's avatar
Denis_P committed
101
  stage:                           workspace
Denis_P's avatar
Denis_P committed
102
  <<:                              *docker-env
Denis_P's avatar
Denis_P committed
103
  needs:
104
105
    - job:                         check-wasm
      artifacts:                   false
Denis_P's avatar
Denis_P committed
106
  script:
107
    - for crate in ${ALSO_WASM_CRATES}; do
108
        cargo build --verbose --no-default-features --release --target wasm32-unknown-unknown --manifest-path crates/${crate}/Cargo.toml;
Hero Bird's avatar
Hero Bird committed
109
      done
Denis_P's avatar
Denis_P committed
110

Denis_P's avatar
Denis_P committed
111
112
test:
  stage:                           workspace
Denis_P's avatar
Denis_P committed
113
  <<:                              *docker-env
Denis_P's avatar
Denis_P committed
114
  needs:
115
116
    - job:                         check-std
      artifacts:                   false
117
118
119
120
121
122
  variables:
      # Since we run the tests with `--all-features` this implies the feature
      # `ink-fuzz-tests` as well -- i.e. the fuzz tests are run.
      # There's no way to disable a single feature while enabling all features
      # at the same time, hence we use this workaround.
      QUICKCHECK_TESTS:            0
Denis_P's avatar
Denis_P committed
123
  script:
124
    - cargo test --verbose --all-features --no-fail-fast --workspace
125
    - cargo test --verbose --all-features --no-fail-fast --workspace --doc
126

127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
docs:
  stage:                           workspace
  <<:                              *docker-env
  variables:
    RUSTDOCFLAGS: -Dwarnings
  artifacts:
    name: "${CI_JOB_NAME}_${CI_COMMIT_REF_NAME}-doc"
    when: on_success
    expire_in: 7 days
    paths:
      - ./crate-docs/
  script:
    - cargo doc --no-deps --all-features
        -p scale-info -p ink_metadata
        -p ink_env -p ink_storage -p ink_storage_derive
        -p ink_primitives -p ink_prelude
        -p ink_lang -p ink_lang_macro -p ink_lang_ir -p ink_lang_codegen
    - mv ${CARGO_TARGET_DIR}/doc ./crate-docs

146
147
148
spellcheck:
    stage:                           workspace
    <<:                              *docker-env
149
150
151
    rules:
      - if: $CI_PIPELINE_SOURCE == "pipeline"
        when: never
152
153
154
    script:
        - cargo spellcheck check --cfg=.config/cargo_spellcheck.toml --checkers hunspell --code 1

155
156
157
158
codecov:
  stage:                           workspace
  <<:                              *docker-env
  needs:
159
160
    - job:                         check-std
      artifacts:                   false
161
  variables:
162
    # For codecov it's sufficient to run the fuzz tests only once.
163
    QUICKCHECK_TESTS:              1
Denis_P's avatar
Denis_P committed
164
    # Variables partly came from https://github.com/mozilla/grcov/blob/master/README.md
165
    CARGO_INCREMENTAL:             0
166
167
    RUSTFLAGS:                     "-Zprofile -Zmir-opt-level=0 -Ccodegen-units=1
                                      -Copt-level=0 -Clink-dead-code -Coverflow-checks=off"
Denis_P's avatar
Denis_P committed
168
169
170
    # The `cargo-taurpalin` coverage reporting tool seems to have better code instrumentation and thus
    # produces better results for Rust codebases in general. However, unlike `grcov` it requires
    # running docker with `--security-opt seccomp=unconfined` which is why we use `grcov` instead.
Denis_P's avatar
Denis_P committed
171
172
173
174
175
  before_script:
    - cargo -vV
    - rustc -vV
    - rustup show
    - bash --version
176
177
    - unset "CARGO_TARGET_DIR"
    - cargo clean
Denis_P's avatar
Denis_P committed
178
179
  script:
    # RUSTFLAGS are the cause target cache can't be used here
180
    - cargo build --verbose --all-features --workspace
Denis_P's avatar
Denis_P committed
181
    - cargo test --verbose --all-features --no-fail-fast --workspace
Denis_P's avatar
Denis_P committed
182
    # coverage with branches
Denis_P's avatar
Denis_P committed
183
184
185
    - grcov . --source-dir . --output-type lcov --llvm --branch --ignore-not-existing
        --ignore "/*" --ignore "tests/*" --output-path lcov-w-branch.info
    - rust-covfix lcov-w-branch.info --output lcov-w-branch-fixed.info
186
187
    # We'd like to not use a remote bash script for uploading the coverage reports,
    # however this job seems to be more tricky than we hoped.
Denis_P's avatar
Denis_P committed
188
    - bash <(curl -s https://codecov.io/bash) -t "$CODECOV_P_TOKEN" -f lcov-w-branch-fixed.info
Denis_P's avatar
Denis_P committed
189
    # lines coverage
Denis_P's avatar
Denis_P committed
190
191
192
193
    - grcov . --source-dir . --output-type lcov --llvm --ignore-not-existing
        --ignore "/*" --ignore "tests/*" --output-path lcov-lines.info
    - rust-covfix lcov-lines.info --output lcov-lines-fixed.info
    - bash <(curl -s https://codecov.io/bash) -f lcov-lines-fixed.info
Denis_P's avatar
Denis_P committed
194

Hero Bird's avatar
Hero Bird committed
195
clippy-std:
Denis_P's avatar
Denis_P committed
196
  stage:                           workspace
Denis_P's avatar
Denis_P committed
197
  <<:                              *docker-env
Denis_P's avatar
Denis_P committed
198
  needs:
199
200
    - job:                         check-std
      artifacts:                   false
Denis_P's avatar
Denis_P committed
201
  script:
Hero Bird's avatar
Hero Bird committed
202
    - for crate in ${ALL_CRATES}; do
203
        cargo clippy --verbose --all-features --manifest-path crates/${crate}/Cargo.toml -- -D warnings;
Hero Bird's avatar
Hero Bird committed
204
      done
Denis_P's avatar
Denis_P committed
205

Hero Bird's avatar
Hero Bird committed
206
clippy-wasm:
Denis_P's avatar
Denis_P committed
207
  stage:                           workspace
Denis_P's avatar
Denis_P committed
208
  <<:                              *docker-env
Denis_P's avatar
Denis_P committed
209
  needs:
210
211
    - job:                         check-wasm
      artifacts:                   false
Denis_P's avatar
Denis_P committed
212
  script:
213
    - for crate in ${ALSO_WASM_CRATES}; do
214
        cargo clippy --verbose --no-default-features --manifest-path crates/${crate}/Cargo.toml --target wasm32-unknown-unknown -- -D warnings;
Hero Bird's avatar
Hero Bird committed
215
216
217
      done

fmt:
Denis_P's avatar
Denis_P committed
218
  stage:                           workspace
Hero Bird's avatar
Hero Bird committed
219
220
  <<:                              *docker-env
  script:
Hero Bird's avatar
Hero Bird committed
221
    - cargo fmt --verbose --all -- --check
Hero Bird's avatar
Hero Bird committed
222

223
224
225
    # For the UI tests we need to disable the license check
    - cargo fmt --verbose --all -- --check --config=license_template_path="" crates/lang/macro/tests/ui/{pass,fail}/*.rs

Denis_P's avatar
Denis_P committed
226

Denis_P's avatar
Denis_P committed
227
#### stage:                        examples
Denis_P's avatar
Denis_P committed
228

Hero Bird's avatar
Hero Bird committed
229
examples-test:
Denis_P's avatar
Denis_P committed
230
  stage:                           examples
Denis_P's avatar
Denis_P committed
231
  <<:                              *docker-env
Denis_P's avatar
Denis_P committed
232
  needs:
233
234
    - job:                         clippy-std
      artifacts:                   false
Denis_P's avatar
Denis_P committed
235
  script:
236
    - for example in examples/*/; do
Denis_P's avatar
Denis_P committed
237
        cargo test --verbose --manifest-path ${example}/Cargo.toml;
Denis_P's avatar
Denis_P committed
238
      done
239
240
241
    - for contract in ${DELEGATOR_SUBCONTRACTS}; do
        cargo test --verbose --manifest-path examples/delegator/${contract}/Cargo.toml;
      done
Denis_P's avatar
Denis_P committed
242

Hero Bird's avatar
Hero Bird committed
243
examples-fmt:
Denis_P's avatar
Denis_P committed
244
  stage:                           examples
Denis_P's avatar
Denis_P committed
245
246
  <<:                              *docker-env
  script:
247
    - for example in examples/*/; do
Hero Bird's avatar
Hero Bird committed
248
        cargo fmt --verbose --manifest-path ${example}/Cargo.toml -- --check;
Denis_P's avatar
Denis_P committed
249
      done
250
251
252
    - for contract in ${DELEGATOR_SUBCONTRACTS}; do
        cargo fmt --verbose --manifest-path examples/delegator/${contract}/Cargo.toml -- --check;
      done
Denis_P's avatar
Denis_P committed
253

Hero Bird's avatar
Hero Bird committed
254
examples-clippy-std:
Denis_P's avatar
Denis_P committed
255
  stage:                           examples
Denis_P's avatar
Denis_P committed
256
  <<:                              *docker-env
Denis_P's avatar
Denis_P committed
257
  needs:
258
259
    - job:                         clippy-std
      artifacts:                   false
Denis_P's avatar
Denis_P committed
260
  script:
261
    - for example in examples/*/; do
262
        cargo clippy --verbose --manifest-path ${example}/Cargo.toml -- -D warnings;
Hero Bird's avatar
Hero Bird committed
263
      done
264
265
266
    - for contract in ${DELEGATOR_SUBCONTRACTS}; do
        cargo clippy --verbose --manifest-path examples/delegator/${contract}/Cargo.toml -- -D warnings;
      done
Hero Bird's avatar
Hero Bird committed
267
268
269
270
271

examples-clippy-wasm:
  stage:                           examples
  <<:                              *docker-env
  script:
272
    - for example in examples/*/; do
273
        cargo clippy --verbose --manifest-path ${example}/Cargo.toml --no-default-features --target wasm32-unknown-unknown -- -D warnings;
Hero Bird's avatar
Hero Bird committed
274
      done
275
276
277
    - for contract in ${DELEGATOR_SUBCONTRACTS}; do
        cargo clippy --verbose --manifest-path examples/delegator/${contract}/Cargo.toml --no-default-features --target wasm32-unknown-unknown -- -D warnings;
      done
Hero Bird's avatar
Hero Bird committed
278
279
280
281
282

examples-contract-build:
  stage:                           examples
  <<:                              *docker-env
  script:
283
    - cargo contract -V
284
    - for example in examples/*/; do
Hero Bird's avatar
Hero Bird committed
285
286
287
288
        pushd $example &&
        cargo contract build &&
        popd;
      done
289
290
291
292
293
294
295
296
297
298
299
300
    - for contract in ${DELEGATOR_SUBCONTRACTS}; do
        pushd examples/delegator/$contract &&
        cargo contract build &&
        popd;
      done

examples-contract-build-delegator:
    stage:                           examples
    <<:                              *docker-env
    script:
        - cargo contract -V
        - cd examples/delegator/ && ./build-all.sh
Hero Bird's avatar
Hero Bird committed
301

302
303
304
305
306
307
308
309
310
311
312
313
314
examples-docs:
    stage:                           examples
    <<:                              *docker-env
    variables:
        RUSTDOCFLAGS: -Dwarnings
    script:
        # `--document-private-items` needs to be in here because currently our contract macro
        # puts the contract functions in a private module.
        # Once https://github.com/paritytech/ink/issues/336 has been implemented we can get rid
        # of this flag.
        - for example in examples/*/; do
            cargo doc --manifest-path ${example}/Cargo.toml --document-private-items --verbose --no-deps;
          done
315
316
317
        - for contract in ${DELEGATOR_SUBCONTRACTS}; do
            cargo doc --manifest-path examples/delegator/${contract}/Cargo.toml --document-private-items --verbose --no-deps;
          done
318

Denis_P's avatar
Denis_P committed
319
320
321
322
323
#### stage:                        publish

publish-docs:
  stage:                           publish
  <<:                              *docker-env
324
325
326
  needs:
    - job:                       docs
      artifacts:                 true
Denis_P's avatar
Denis_P committed
327
  variables:
Denis_P's avatar
Denis_P committed
328
    GIT_DEPTH:                   100
329
330
331
332
333
  rules:
    - if: $CI_PIPELINE_SOURCE == "web"
    - if: $CI_PIPELINE_SOURCE == "schedule"
    - if: $CI_COMMIT_REF_NAME == "master"
    - if: $CI_COMMIT_REF_NAME == "tags"
334
335
336
337
  # need to overwrite `before_script` from `*docker-env` here,
  # this branch does not have a `./scripts/pre_cache.sh`
  before_script:
    - unset CARGO_TARGET_DIR
Denis_P's avatar
Denis_P committed
338
  script:
Denis_P's avatar
Denis_P committed
339
    - rm -rf /tmp/*
Denis_P's avatar
Denis_P committed
340
    # Set git config
Denis_P's avatar
Denis_P committed
341
    - rm -rf .git/config
Denis_P's avatar
Denis_P committed
342
343
    - git config user.email "devops-team@parity.io"
    - git config user.name "${GITHUB_USER}"
Denis_P's avatar
Denis_P committed
344
    - git config remote.origin.url "https://${GITHUB_TOKEN}@github.com/paritytech/ink.git"
Denis_P's avatar
Denis_P committed
345
346
    - git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*"
    - git fetch origin gh-pages
Denis_P's avatar
Denis_P committed
347
    # saving README and docs
348
    - cp -r ./crate-docs/ /tmp/doc/
Denis_P's avatar
Denis_P committed
349
    - cp README.md /tmp/doc/
350
    - cp -r .images/ /tmp/doc/
Denis_P's avatar
Denis_P committed
351
    - git checkout gh-pages
Denis_P's avatar
Denis_P committed
352
353
    - mv _config.yml /tmp/doc/
    # remove everything and restore generated docs, README and Jekyll config
Denis_P's avatar
Denis_P committed
354
    - rm -rf ./*
355
    - rm -rf ./.images
Denis_P's avatar
Denis_P committed
356
    - mv /tmp/doc/* .
357
    - mv /tmp/doc/.images .
Denis_P's avatar
Denis_P committed
358
    # Upload files
Denis_P's avatar
Denis_P committed
359
    - git add --all --force
Denis_P's avatar
Denis_P committed
360
    - git status
Michael Müller's avatar
Michael Müller committed
361
362
363
364
365
366
    # `git commit` has an exit code of > 0 if there is nothing to commit.
    # This unfortunately causes GitLab to exit immediately and mark this
    # job as failed subsequently.
    # We don't want to mark the entire job as failed if there's nothing to
    # publish though, hence the `|| true`.
    - git commit -m "Updated docs for ${CI_COMMIT_REF_NAME} and pushed to gh-pages" || true
Denis_P's avatar
Denis_P committed
367
    - git push origin gh-pages --force
Denis_P's avatar
Denis_P committed
368
369
  after_script:
    - rm -rf .git/ ./*
370
371
372
373
374
375
376
377

#### stage:                        fuzz

fuzz-tests:
    stage:                           fuzz
    <<:                              *docker-env
    variables:
        # The QUICKCHECK_TESTS default is 100
378
        QUICKCHECK_TESTS:            20000
379
380
381
382
383
384
385
386
387
    rules:
        - if: $CI_PIPELINE_SOURCE == "schedule"
        - if: $CI_COMMIT_REF_NAME == "master"
    script:
        # We fuzz-test only crates which possess the `ink-fuzz-tests` feature
        - all_tests_passed=0
        - for crate in ${ALL_CRATES}; do
            if grep "ink-fuzz-tests =" crates/${crate}/Cargo.toml;
            then
388
                cargo test --verbose --features ink-fuzz-tests --manifest-path crates/${crate}/Cargo.toml --no-fail-fast -- fuzz_ || exit_code=$?;
Michael Müller's avatar
Michael Müller committed
389
                all_tests_passed=$(( all_tests_passed | exit_code ));
390
391
392
393
            fi
          done
        - if [ $all_tests_passed -eq 0 ]; then exit 0; fi
        - |
Michael Müller's avatar
Michael Müller committed
394
             curl -X "POST" "https://api.github.com/repos/paritytech/ink/issues" \
395
396
                -H "Cookie: logged_in=no" \
                -H "Authorization: token ${GITHUB_TOKEN}" \
Michael Müller's avatar
Michael Müller committed
397
                -H "Content-Type: application/json; charset=utf-8" \
398
                -d $'{
Michael Müller's avatar
Michael Müller committed
399
400
                    "title": "[ci] Failing fuzz tests on master ('"$( date +"%d %b %Y" )"')",
                    "body": "The CI job ['"${CI_JOB_ID}"']('"${CI_JOB_URL}"') just failed.\n\nThe offending commit is ['"${CI_COMMIT_TITLE}"'](https://github.com/paritytech/ink/commit/'"${CI_COMMIT_SHA}"').",
401
402
403
404
405
                    "assignees": [],
                    "labels": [
                        "P-high"
                    ]
                }'
Michael Müller's avatar
Michael Müller committed
406
        - exit ${all_tests_passed}