Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make XS CI optional #2647

Closed
warner opened this issue Mar 15, 2021 · 2 comments · Fixed by #2651
Closed

make XS CI optional #2647

warner opened this issue Mar 15, 2021 · 2 comments · Fixed by #2651
Assignees
@warner @dckc
Labels
enhancement New feature or request tooling repo-wide infrastructure

Comments

@warner
Copy link
Member

warner commented Mar 15, 2021

What is the Problem Being Solved?

We're seeing some strange test failures (involving GC and WeakMap) when certain unit tests (especially Zoe) are run under XS. These are serious problems but not a direct consequence of the Zoe changes being made, so they probably shouldn't hold up landing the Zoe PRs.

We decided to make the XS CI optional, so failures in it are reported, but won't prevent a PR from landing.

Description of the Design

Currently our top-level yarn test expands to a yarn workspaces test, which runs yarn test in each package in turn. Then, within several packages (ERTP and zoe), the yarn test target expands to yarn test:node && yarn test:xs.

I think we need to rotate that: add a top-level yarn test:xs target, which expands to yarn workspaces test:xs. We'll add a "test:xs": "exit 0" to all of the other packages. And then we'll revert the ERTP/zoe yarn test:node && yarn test:xs bit.

Finally, we'll modify .github/workflows/test-all-packages.yml to introduce a new job (with continue-on-error: true to make it not flunk PRs). This job will run yarn test:xs at the top level.
@warner warner added enhancement New feature or request tooling repo-wide infrastructure labels Mar 15, 2021
@dckc
Copy link
Member

dckc commented Mar 15, 2021

@michaelfig pointed out that we're running test:xs 3x for 3 different versions of node. Is that a bug or a feature?

warner added a commit that referenced this issue Mar 15, 2021
@warner
fix: make separate 'test:xs' target, remove XS from 'test' target
e8c92b6 
Running `yarn test` from the top level causes `yarn test` to be
run in each workspace.

Previously, in some packages (zoe and ERTP in particular), the local `yarn
test` expanded into doing both `test:node` and `test:xs`.

This introduces a new top-level `yarn test:xs` target, which runs `yarn
test:xs` in each workspace. Zoe and ERTP's local `yarn test` was changed to
only run the node tests. Zoe and ERTP 's local `yarn test:xs` runs the unit
tests under XS. All other packages have a no-op `exit 0` in their `test:xs`
target, so the top-level target doesn't crash when it encounters a package
that doesn't have any XS-specific testing (which is most of them).

With this change, CI will stop testing XS on each run. We'll follow up with a
separate change that tells CI to do a top-level `yarn test:xs`, probably with
a flag that makes the success optional (don't flunk a PR if it fails the XS
tests, for now).

refs #2647
@warner warner mentioned this issue Mar 15, 2021
Merged
warner added a commit that referenced this issue Mar 15, 2021
@warner
fix: make separate 'test:xs' target, remove XS from 'test' target
b9c1a69 
Running `yarn test` from the top level causes `yarn test` to be
run in each workspace.

Previously, in some packages (zoe and ERTP in particular), the local `yarn
test` expanded into doing both `test:node` and `test:xs`.

This introduces a new top-level `yarn test:xs` target, which runs `yarn
test:xs` in each workspace. Zoe and ERTP's local `yarn test` was changed to
only run the node tests. Zoe and ERTP 's local `yarn test:xs` runs the unit
tests under XS. All other packages have a no-op `exit 0` in their `test:xs`
target, so the top-level target doesn't crash when it encounters a package
that doesn't have any XS-specific testing (which is most of them).

With this change, CI will stop testing XS on each run. We'll follow up with a
separate change that tells CI to do a top-level `yarn test:xs`, probably with
a flag that makes the success optional (don't flunk a PR if it fails the XS
tests, for now).

refs #2647
warner added a commit that referenced this issue Mar 15, 2021
@warner
chore: CI will run test:xs, but failures won't block PRs
733ef60 
closes #2647
@warner warner mentioned this issue Mar 15, 2021
Merged
@warner
Copy link
Member Author

warner commented Mar 15, 2021

@michaelfig pointed out that we're running test:xs 3x for 3 different versions of node. Is that a bug or a feature?

That's probably a bug, the amount of Node.js code running under test:xs is minimal and not very interesting. I'll change #2651 so that the matrix: node-version clause only runs under a single version (
14.x).

warner added a commit that referenced this issue Mar 15, 2021
@warner
chore: CI will run test:xs, but failures won't block PRs
33fc79c 
The amount of Node.js code that runs under `test:xs` is minimal and not very
interesting, so save time by only running test:xs under node-14.x .

closes #2647
warner added a commit that referenced this issue Mar 16, 2021
@warner
chore: CI will run test:xs, but failures won't block PRs
41748eb 
The amount of Node.js code that runs under `test:xs` is minimal and not very
interesting, so save time by only running test:xs under node-14.x .

closes #2647
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@warner warner

@dckc dckc

Labels
enhancement New feature or request tooling repo-wide infrastructure
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: CI will run test:xs, but failures won't block PRs Agoric/agoric-sdk
2 participants
@warner @dckc