Skip to content

Commit

Permalink
Update instructions on how to run tests (#258)
Browse files Browse the repository at this point in the history
## Type of change

<!--Delete points that do not apply-->

- Improvement (refactoring, restructuring repository, cleaning tech
debt, ...)

## Changes

The following changes have been made:

- Updates the README with new instructions on how to run tests
- Updates the doc hub with new instructions on how to run tests

## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [x] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [x] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.
- [x] I have updated the changelog to reflect the changes on this PR.
  • Loading branch information
bitzoic committed Jun 19, 2024
1 parent b1c57e3 commit d299d2d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 19 deletions.
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Description of the upcoming release here.

### Fixed

- Some fix here 1
- Some fix here 2
- [#258](https://github.com/FuelLabs/sway-libs/pull/258) Fixes incorrect intructions on how to run tests in README and docs hub.

#### Breaking

Expand Down
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,22 +91,20 @@ For more information about implementation please refer to the [Sway Libs Docs Hu

## Running Tests

There are two sets of tests that should be run: inline tests and sdk-harness tests.
There are two sets of tests that should be run: inline tests and sdk-harness tests. Please make sure you are using `forc v0.60.0` and `fuel-core v0.26.0`. You can check what verison you are using by running the `fuelup show` command.

In order to run the inline tests, make sure you are in the `libs/` folder of this repository `sway-libs/libs/<you are here>`.
Make sure you are in the source directory of this repository `sway-libs/<you are here>`.

Run the tests:
Run the inline tests:

```bash
forc test
forc test --path libs --release --locked
```

Once these tests have passed, make sure you are in the `tests/` folder of this repository `sway-libs/tests/<you are here>`.

Run the tests:
Once these tests have passed, run the sdk-harness tests:

```bash
forc test && cargo test
forc test --path tests --release --locked && cargo test --manifest-path tests/Cargo.toml
```

> **NOTE:**
Expand All @@ -115,7 +113,7 @@ forc test && cargo test
Any instructions related to using a specific library should be found within the README.md of that library.

> **NOTE:**
> All projects currently use `forc v0.60.0`, `fuels-rs v0.62.0` and `fuel-core 0.26.0`.
> All projects currently use `forc v0.60.0`, `fuels-rs v0.62.0` and `fuel-core v0.26.0`.
## Contributing

Expand Down
14 changes: 6 additions & 8 deletions docs/book/src/getting_started/running_tests.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
# Running Tests

There are two sets of tests that should be run: inline tests and sdk-harness tests.
There are two sets of tests that should be run: inline tests and sdk-harness tests. Please make sure you are using `forc v0.60.0` and `fuel-core v0.26.0`. You can check what version you are using by running the `fuelup show` command.

In order to run the inline tests, make sure you are in the `libs/` folder of this repository `sway-libs/libs/<you are here>`.
Make sure you are in the source directory of this repository `sway-libs/<you are here>`.

Run the tests:
Run the inline tests:

```bash
forc test
forc test --path libs --release --locked
```

Once these tests have passed, make sure you are in the `tests/` folder of this repository `sway-libs/tests/<you are here>`.

Run the tests:
Once these tests have passed, run the sdk-harness tests:

```bash
forc test && cargo test
forc test --path tests --release --locked && cargo test --manifest-path tests/Cargo.toml
```

> **NOTE:**
Expand Down

0 comments on commit d299d2d

Please sign in to comment.