Fix test script silent failure #422

tcharding · 2022-03-19T00:11:37Z

Change the test script to exit with non-zero status code if any command fails.

The test.sh script is silently failing, that means changes causing failures are slipping through our CI pipeline and being merged.

Resolves: #419

Note

Just the last 3 patches, the first 6 are from #420. re-base just shows it works on top of 420, it is going to have to be rebased again when 420 merges.

apoelstra

ACK e080754

Big improvement! Though maybe we shouldn't merge it while WASM is broken.

tcharding · 2022-03-21T23:16:17Z

I noticed the clang sanity check is missing in one case and a little wrong in the other. I pushed an additional patch to fix that.

Though maybe we shouldn't merge it while WASM is broken.

It shouldn't get through CI till then ;)

apoelstra · 2022-03-22T13:47:22Z

utACK 51a79fb

Remove single character of trailing whitespace.

tcharding · 2022-03-29T00:49:11Z

Bringing to your attention @apoelstra that this PR removes the pipes instead of using the option you proposed someplace else to make any command in a pipe fail (set -o pipefail I think it was).

In line with the `Tests` job and for the fact that this job does stuff with the nightly toolchain other than bench. Re-name nightly CI job from `bench_nightly`to `Nightly`.

We use a matrix with a single element, this is unnecessary.

The address sanitizer job is silently failing at the moment because we do not install clang. Install clang so the address sanitizer job can run. Do not fix the silent failure, that will be done later on.

We have a separate CI job for things that require a nightly toolchain. Building the docs requires a nightly toolchain (because of `--cfg docsrc` flag). It makes more sense to run the docs build in the `Nightly` job instead of hidden in the `Tests` job. Do the docs build in the `Nightly` job instead of in the `Tests` job.

WASM is supported by Rust 1.30. We can therefore run the WASM tests on any all the toolchains except MSRV (1.29.0). This has benefit of catching nightly/beta issues before they get to stable. Done as a separate CI job since it is conceptually different to the `Tests` job. Run WASM for nightly, beta, and stable toolchains.

apoelstra · 2022-03-30T12:48:23Z

Yep, I am aware -- I suggested pipefail after this PR was open, actually :). (I'm also not sure if pipefail is actually what we want, since these are && connectors rather than pipes..)

In any case, I think it's clearer to have -e on and to not use &&. Thanks.

bfd88db Move WASM const definitions to a source file (Tobin Harding) Pull request description: Total re-write ... again :) Currently we are defining the WASM integer size and alignments in the `stdio.h` header file, this is wrong because this file is included in the build by way of `build.rs` as well as by upstream `libsecp256k1`. Move WASM integer definitions to a `C` source file and build the file into the binary if target is WASM. Fixes the first part of #419 (#422 does the second part). ### Note to reviewers I'm not exactly sure why the directory `was-sysroot` is named as it is or if the name is significant to `cargo` , please review carefully the directory tree changes. ``` cd secp256k1-sys tree wasm wasm ├── wasm.c └── wasm-sysroot ├── stdio.h ├── stdlib.h └── string.h ``` ACKs for top commit: thomaseizinger: ACK bfd88db apoelstra: ACK bfd88db Tree-SHA512: ba822b764fb5f74dfd22cc797f7e3f70440dbaabfe34e0475c796e0e5d88f2086bedb00a1ec765cce91bde6bb45130b9abe5d9289317d6c20f692c6ed711969e

thomaseizinger

ACK 51a79fb

I think this needs a rebase onto #420 so we have clang-9 available for the WASM stuff.

thomaseizinger · 2022-03-31T03:00:57Z

contrib/test.sh

    cargo bench --all --features="unstable"
 fi

+exit 0


What is the benefit of explicitly saying exit 0? Isn't that the default?

The default exit status is the exit status of the last command, because we use set -e to exit the script early if any command fails then it is going to be 0. I like to do it explicitly though.

tcharding · 2022-03-31T04:40:49Z

I think this needs a rebase onto #420 so we have clang-9 available for the WASM stuff.

Yes, now that #421 merged #420 is the only one left :)

tcharding · 2022-03-31T04:47:43Z

Rebased on #420, might be able to merge without me rebasing again, let's see :)

As per UNIX convention a Bash script should exit with status code 0 if it completes successfully.

Currently the `test.sh` script is silently failing because we do not exit if a command fails. We can achieve this by using the Bash builtin `set -e`. For some reason I cannot explain a chain of commands that fails does not fail the script. Instead of working out _why_ just remove the chain and run each command on its own. This is functionally the same and, I hazard a guess, is what the original author hoped to achieve with the chaining.

For the test that uses `clang-9` do the sanity call using `clang-9` instead of `clang`. For the test that uses `clang` add a sanity call to `clang --version`.

58db1b6 Run WASM for multiple toolchains (Tobin Harding) 946ac3b Do docs build in Nightly job (Tobin Harding) f7bc7d3 Install clang to run adress sanitizer (Tobin Harding) 96685c5 Remove unnecessary matrix (Tobin Harding) a8a679e Re-name nightly CI job to Nightly (Tobin Harding) 9c9d622 Remove trailing whitespace (Tobin Harding) Pull request description: Improve the CI pipeline. Done while investigating #419. This PR now only includes the GitHub actions changes, I'm moving the `test.sh` changes to a #422 because they cannot be merged yet. (Please note, this PR has been heavily re-worked so discussion below may be confusing to reviewers new to the PR.) ACKs for top commit: apoelstra: ACK 58db1b6 thomaseizinger: ACK 58db1b6 Tree-SHA512: 5520cf7a7ea0ba701aeaf6b97150416192c0629df8b65545a20d8937a4d76bd323a0d7a875deccb7ce9adc4f3a423e6cd27b300682f206f79407f5ab4eaa5ddb

apoelstra · 2022-04-01T17:09:39Z

Looks like both GIthub and my local commit-labelling tool are smart enough to do the right thing, since #420 is merged. (Well, Github still shows "9 commits" and doesn't indicate that they're shared, but it doesn't demand a rebase, so all good.)

apoelstra

ACK 97dc0ea

Thank you for doing this!

58db1b67536794b24cdc0bf8149460509a247b31 Run WASM for multiple toolchains (Tobin Harding) 946ac3b51ebb8191b051c8d80bd27bee1656993e Do docs build in Nightly job (Tobin Harding) f7bc7d3728326e6de0d2462dfba9705b93a1f55e Install clang to run adress sanitizer (Tobin Harding) 96685c571da4f3c64d178e0f0d3a02ce99de9136 Remove unnecessary matrix (Tobin Harding) a8a679ed7dbfa4871270de779aee78b3cdaeebd6 Re-name nightly CI job to Nightly (Tobin Harding) 9c9d622b0ee26a3de2d43de298ded822245520a4 Remove trailing whitespace (Tobin Harding) Pull request description: Improve the CI pipeline. Done while investigating #419. This PR now only includes the GitHub actions changes, I'm moving the `test.sh` changes to a rust-bitcoin/rust-secp256k1#422 because they cannot be merged yet. (Please note, this PR has been heavily re-worked so discussion below may be confusing to reviewers new to the PR.) ACKs for top commit: apoelstra: ACK 58db1b67536794b24cdc0bf8149460509a247b31 thomaseizinger: ACK 58db1b67536794b24cdc0bf8149460509a247b31 Tree-SHA512: 5520cf7a7ea0ba701aeaf6b97150416192c0629df8b65545a20d8937a4d76bd323a0d7a875deccb7ce9adc4f3a423e6cd27b300682f206f79407f5ab4eaa5ddb

97dc0ea9acdc308cc2cadc11e4787d07ec9b2c79 Run correct clang --version (Tobin Harding) a3582ff77dec8f4c5855fa38f4b8ff6bef700169 test.sh: Use set -e to exit on failure (Tobin Harding) 7bec31c3a6eb43068f0b28db5f351b079751b2e2 test.sh: explicitly return 0 (Tobin Harding) Pull request description: Change the test script to exit with non-zero status code if any command fails. The `test.sh` script is silently failing, that means changes causing failures are slipping through our CI pipeline and being merged. Resolves: #419 ## Note Just the last 3 patches, the first 6 are from #420. re-base just shows it works on top of 420, it is going to have to be rebased again when 420 merges. ACKs for top commit: apoelstra: ACK 97dc0ea9acdc308cc2cadc11e4787d07ec9b2c79 Tree-SHA512: b86a6876d8c45a2b90b7b3c8adbc08ad6f49b430b1cfaec31cd2de8441cb96af39c63da02b98d6ed71dfab045d466d71d3757297886b5e44ebb6cbaeb4ed32dd

58db1b67536794b24cdc0bf8149460509a247b31 Run WASM for multiple toolchains (Tobin Harding) 946ac3b51ebb8191b051c8d80bd27bee1656993e Do docs build in Nightly job (Tobin Harding) f7bc7d3728326e6de0d2462dfba9705b93a1f55e Install clang to run adress sanitizer (Tobin Harding) 96685c571da4f3c64d178e0f0d3a02ce99de9136 Remove unnecessary matrix (Tobin Harding) a8a679ed7dbfa4871270de779aee78b3cdaeebd6 Re-name nightly CI job to Nightly (Tobin Harding) 9c9d622b0ee26a3de2d43de298ded822245520a4 Remove trailing whitespace (Tobin Harding) Pull request description: Improve the CI pipeline. Done while investigating #419. This PR now only includes the GitHub actions changes, I'm moving the `test.sh` changes to a rust-bitcoin/rust-secp256k1#422 because they cannot be merged yet. (Please note, this PR has been heavily re-worked so discussion below may be confusing to reviewers new to the PR.) ACKs for top commit: apoelstra: ACK 58db1b67536794b24cdc0bf8149460509a247b31 thomaseizinger: ACK 58db1b67536794b24cdc0bf8149460509a247b31 Tree-SHA512: 5520cf7a7ea0ba701aeaf6b97150416192c0629df8b65545a20d8937a4d76bd323a0d7a875deccb7ce9adc4f3a423e6cd27b300682f206f79407f5ab4eaa5ddb

97dc0ea9acdc308cc2cadc11e4787d07ec9b2c79 Run correct clang --version (Tobin Harding) a3582ff77dec8f4c5855fa38f4b8ff6bef700169 test.sh: Use set -e to exit on failure (Tobin Harding) 7bec31c3a6eb43068f0b28db5f351b079751b2e2 test.sh: explicitly return 0 (Tobin Harding) Pull request description: Change the test script to exit with non-zero status code if any command fails. The `test.sh` script is silently failing, that means changes causing failures are slipping through our CI pipeline and being merged. Resolves: #419 ## Note Just the last 3 patches, the first 6 are from #420. re-base just shows it works on top of 420, it is going to have to be rebased again when 420 merges. ACKs for top commit: apoelstra: ACK 97dc0ea9acdc308cc2cadc11e4787d07ec9b2c79 Tree-SHA512: b86a6876d8c45a2b90b7b3c8adbc08ad6f49b430b1cfaec31cd2de8441cb96af39c63da02b98d6ed71dfab045d466d71d3757297886b5e44ebb6cbaeb4ed32dd

This was referenced Mar 19, 2022

Improve CI script #420

Merged

Fix wasm build #421

Merged

Combine PRs for ease of merging #423

Closed

Latest release (0.5.0) does not work on WASM & test.shis broken #419

Closed

apoelstra previously approved these changes Mar 21, 2022

View reviewed changes

tcharding dismissed apoelstra’s stale review via 51a79fb March 21, 2022 23:14

Remove trailing whitespace

9c9d622

Remove single character of trailing whitespace.

tcharding added 5 commits March 30, 2022 08:44

Re-name nightly CI job to Nightly

a8a679e

In line with the `Tests` job and for the fact that this job does stuff with the nightly toolchain other than bench. Re-name nightly CI job from `bench_nightly`to `Nightly`.

Remove unnecessary matrix

96685c5

We use a matrix with a single element, this is unnecessary.

Install clang to run adress sanitizer

f7bc7d3

The address sanitizer job is silently failing at the moment because we do not install clang. Install clang so the address sanitizer job can run. Do not fix the silent failure, that will be done later on.

thomaseizinger previously approved these changes Mar 31, 2022

View reviewed changes

tcharding dismissed thomaseizinger’s stale review via 1e229b3 March 31, 2022 04:46

tcharding force-pushed the fix-test-script branch from 51a79fb to 1e229b3 Compare March 31, 2022 04:46

tcharding added 3 commits March 31, 2022 15:51

test.sh: explicitly return 0

7bec31c

As per UNIX convention a Bash script should exit with status code 0 if it completes successfully.

Run correct clang --version

97dc0ea

For the test that uses `clang-9` do the sanity call using `clang-9` instead of `clang`. For the test that uses `clang` add a sanity call to `clang --version`.

tcharding force-pushed the fix-test-script branch from 1e229b3 to 97dc0ea Compare March 31, 2022 04:52

apoelstra approved these changes Apr 1, 2022

View reviewed changes

apoelstra merged commit e4fb575 into rust-bitcoin:master Apr 1, 2022

tcharding deleted the fix-test-script branch April 4, 2022 02:38

apoelstra mentioned this pull request Jul 25, 2022

Wasm build fails BlockstreamResearch/rust-secp256k1-zkp#47

Closed

Fix test script silent failure #422

Fix test script silent failure #422

Uh oh!

Conversation

tcharding commented Mar 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Note

Uh oh!

apoelstra left a comment

Choose a reason for hiding this comment

Uh oh!

tcharding commented Mar 21, 2022

Uh oh!

apoelstra commented Mar 22, 2022

Uh oh!

tcharding commented Mar 29, 2022

Uh oh!

apoelstra commented Mar 30, 2022

Uh oh!

thomaseizinger left a comment

Choose a reason for hiding this comment

Uh oh!

thomaseizinger Mar 31, 2022

Choose a reason for hiding this comment

Uh oh!

tcharding Mar 31, 2022

Choose a reason for hiding this comment

Uh oh!

tcharding commented Mar 31, 2022

Uh oh!

tcharding commented Mar 31, 2022

Uh oh!

apoelstra commented Apr 1, 2022

Uh oh!

apoelstra left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tcharding commented Mar 19, 2022 •

edited

Loading