Skip to content

docs: a test's node-level arrangement must hold on both e2e lanes #262

Description

@teemow

Problem

CI's e2e lane (upstream's pr-workflow) runs every suite on gVisor and on micro-VM. A node-level arrangement a test makes must hold on both ateoms, and the two differ: the micro-VM ateom clears its checkpoint directory before writing, the gVisor ateom only creates it. #258 DeleteAfterFailedSuspend first blocked the checkpoint with an immutable file, which one lane accepted and the other did not (#256 failed the micro-VM lane on it), and was reworked to a file under the directory's name, which both refuse. Neither CONTRIBUTING.md nor FORK.md says so; CONTRIBUTING.md only names the lanes.

Proposed solution

A paragraph in CONTRIBUTING.md (the "What CI runs on a pull request" item) or a docs/dev/ page linked from it: a test's node-level arrangement runs on both ateoms; the checkpoint-directory difference and the arrangement that holds on both, as the example.

Acceptance criteria

  • The note is in CONTRIBUTING.md or a docs/dev/ page linked from it.

This issue was written by an agent.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    • Status
      Backlog 📦

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions