Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
lucymcnatt committed Feb 4, 2025
1 parent 3edb81c commit 5e6f36d
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/developers/Centaur.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ You can now run the tests from another terminal.

There are two ways to invoke the integration tests:

* `sbt "centaur / IntegrationTest / test"` - compiles Centaur and runs all tests via sbt directly. Tests are expected to be in the `centaur/src/main/standardTestCases` directory. This can be changed by modifying `reference.conf`.
* `sbt "centaur / IntegrationTest / test"` - compiles Centaur and runs all tests via sbt directly.
Tests are expected to be in the `centaur/src/main/standardTestCases` directory. In order to run a set of specific tests, you can create a new subdirectory that contains the tests you would like to run, then change the path by modifying the centaur `reference.conf`.

* `src/ci/bin/testCentaurLocal.sh` - runs the same tests using the continuous integration pipeline configuration.

Expand Down
17 changes: 17 additions & 0 deletions docs/developers/Running.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
In order to run a Cromwell instance locally, there are the prerequisites:
- Have docker and IntelliJ installed
- Start a local mysql instance by running the `start_publish_mysql_docker.sh` script

To run the backend locally, set up your preferred run configuration.
More information on backends can be found here: [Backends](Backends.md)
![](select-run-config.png)

If you've created a new config, you may need to edit your run configuration to point to the correct config file or have the correct environment variables.
Example for batch:
![](edit-run-config.png)


Upon startup, the Cromwell swagger will be available at `http://localhost:8000`.
(You can change the port and other configurations by following [these instructions](../Configuring.md)

**Note**: To verify that workflows are being submitted to the correct backend, look for logs with `Call-to-Backend assignments` and check that the tasks are being directed to `-> GCPBATCH` or `-> PAPI` etc.
Binary file added docs/developers/edit-run-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/developers/select-run-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5e6f36d

Please sign in to comment.