Skip to main content

Agent role manual

White-list repositories​

In the interest of avoiding spam the agenthas to white-list repositories before the oracle will accept test-runs for them.

Two commands are available

White-list a repository​

This will only work if the repository is not already white-listed and the repository is in GitHub.

moog agent white-list <platform> <repository>

ATM only GitHub is supported as a platform. The format of the repository is <owner>/<repository>, e.g. cardano-foundation/moog.

Black-list a repository​

This will only work if the repository is white-listed.

moog agent black-list <platform> <repository>

Query pending test-runs​

The agent is responsible for managing test-runs from pending to running and completed.

moog facts test-runs pending --pretty

will report all the pending test runs in a human friendly format.

Download a test-run assets​

Once a test-run is pending the agent can download the assets for the test-run.

moog agent download -i <test-run-id> -D <directory>

This will download the assets for the test-run with id <test-run-id> into the directory <directory>.

Start a test-run locally​

At the moment there is no moog-cli command to start a test-run locally. But a minimal check could be done via docker compose.

cd <directory>
INTERNAL_NETWORK=true docker compose up --build

Obviously you should do all kind of analysis you deem necessary on the assets before deciding the next step.

Reject a test-run​

If the agent decides a test-run is not acceptable it can reject it.

moog agent reject-test -i <test-run-id> --reason <reason>

Push a test-run to antithesis platform​

Once decided a test-run is acceptable the agent can push the test-run to the antithesis platform.

moog agent push-test -i <test-run-id> -D <directory>

This will push the test-run with id <test-run-id> to the antithesis platform

Report the acceptance of a test-run on-chain​

Once a test-run is pushed to the antithesis platform the agent has to report the acceptance of the test-run on-chain.

moog agent accept-test -i <test-run-id>

This will move it from pending to running state in the facts.

Check for the completion of a test-run​

ATM we can only collect results via email. The email is passed in the post request when the test-run on the recipients list.

export MOOG_AGENT_EMAIL="<your-email>"

Then you can check for the completion of a test-run via

moog agent collect-results-for --test-run-id <test-run-id> --days <n> --ask-agent-email-password

HAL Team

To use your CF email you have to use an app password. If you use your password you will get an error like

LoginFailed user error (NO: Application-specific password required: https://support.google.com/accounts/answer/185833 (Failure))

Just go to https://myaccount.google.com/apppasswords and create an app password.

Report the completion of a test-run on-chain​

Once the result URL is retrieved the agent has to report the completion of the test-run on-chain.

moog agent report-test -i <test-run-id> --url <result-url>  --duration <duration-in-hours>

The URL is encrypted automatically with the requester's public key.