Split forge tests, so they can be filtered out (#232)

<!-- Reference any GitHub issues resolved by this PR -->

## Introduced changes

<!-- A brief description of the changes -->

- split e2e and integration tests, so they can now be invoked
separately:
```
cargo test integration --manifest-path ./starknet-foundry/Cargo.toml -p forge
cargo test e2e --manifest-path ./starknet-foundry/Cargo.toml -p forge
```
of course running all tests is still possible using the same command as
prviously

- Run e2e tests on separate runner, to decrease overall forge tests
execution time

## Breaking changes

None

## Checklist

<!-- Make sure all of these are complete -->

- [X] Linked relevant issue
- [X] Updated relevant documentation
- [X] Added relevant tests
- [X] Performed self-review of the code

Author: THenry14

.github/workflows/ci.yml

@@ -8,8 +8,8 @@ on:
       - master
 
 jobs:
-  test-forge:
-    name: Test Forge
+  test-forge-unit-and-integration:
+    name: Test Forge / Unit and Integration Tests
     env:
       SCARB_VERSION: 0.5.2
     runs-on: ubuntu-latest
@@ -26,7 +26,28 @@ jobs:
       - uses: software-mansion/[email protected]
         with:
           scarb-version: ${{ env.SCARB_VERSION }}
-      - run: cargo test --manifest-path ./starknet-foundry/Cargo.toml -p forge
+      - run: cargo test --lib --manifest-path ./starknet-foundry/Cargo.toml -p forge
+      - run: cargo test integration --manifest-path ./starknet-foundry/Cargo.toml -p forge
+
+  test-forge-e2e:
+    name: Test Forge / E2E Tests
+    env:
+      SCARB_VERSION: 0.5.1
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@dd05243424bd5c0e585e4b55eb2d7615cdd32f1f
+        with:
+          workspaces: |
+            starknet-foundry
+            cairo
+      - uses: software-mansion/[email protected]
+        with:
+          scarb-version: ${{ env.SCARB_VERSION }}
+      - run: cargo test e2e --manifest-path ./starknet-foundry/Cargo.toml -p forge
 
   test-cast:
     name: Test Cast
@@ -89,7 +110,7 @@ jobs:
   clippy:
     runs-on: ubuntu-latest
     env:
-      # Make sure CI fails on all warnings, including Clippy lints.
+      # Make sure CI fails on all warnings - including Clippy lints.
       RUSTFLAGS: "-Dwarnings"
     steps:
       - uses: actions/checkout@v3

CONTRIBUTING.md

@@ -34,6 +34,23 @@ cargo lint
 
 Otherwise, it won't be possible to merge your contribution.
 
+You can also run specific set of tests, by directly running `cargo test`.
+
+For forge tests, make sure you are in `starkent-foundry/crates/forge` directory:
+```shell
+forge $ cargo test --lib        # runs all unit tests
+forge $ cargo test integration  # runs all integration tests
+forge $ cargo test e2e          # runs all e2e tests
+```
+
+Similarly, to run cast tests make sure you are in `starkent-foundry/crates/cast` directory:
+```shell
+cast $ cargo test --lib        # runs lib unit tests
+cast $ cargo test helpers      # runs helpers unit tests
+cast $ cargo test integration  # runs all integration tests
+cast $ cargo test e2e          # runs all e2e tests
+```
+
 ## Contributing
 
 Before you open a pull request, it is always a good idea to search

starknet-foundry/crates/forge/tests/e2e/main.rs renamed to starknet-foundry/crates/forge/tests/e2e/mod.rs

@@ -1,7 +1,7 @@
 use assert_fs::fixture::{FileWriteStr, PathChild, PathCopy};
 use indoc::indoc;
 
-use crate::common::runner::runner;
+use crate::e2e::common::runner::runner;
 
 #[test]
 fn simple_package() {

starknet-foundry/crates/forge/tests/e2e/running.rs

@@ -126,11 +126,11 @@ impl<'a> TestCase {
 #[macro_export]
 macro_rules! test_case {
     ( $test_code:expr ) => ({
-        use $crate::common::runner::TestCase;
+        use $crate::integration::common::runner::TestCase;
         TestCase::from($test_code, vec![]).unwrap()
     });
     ( $test_code:expr, $( $contract:expr ),*) => ({
-        use $crate::common::runner::TestCase;
+        use $crate::integration::common::runner::TestCase;
 
         let contracts = vec![$($contract,)*];
         TestCase::from($test_code, contracts).unwrap()

starknet-foundry/crates/forge/tests/integration/common/runner.rs

@@ -1,5 +1,5 @@
-use crate::common::corelib::{corelib, predeployed_contracts};
-use crate::common::runner::Contract;
+use crate::integration::common::corelib::{corelib, predeployed_contracts};
+use crate::integration::common::runner::Contract;
 use crate::{assert_failed, assert_passed, test_case};
 use camino::Utf8PathBuf;
 use forge::run;

starknet-foundry/crates/forge/tests/integration/declare.rs

@@ -1,5 +1,5 @@
-use crate::common::corelib::{corelib, predeployed_contracts};
-use crate::common::runner::Contract;
+use crate::integration::common::corelib::{corelib, predeployed_contracts};
+use crate::integration::common::runner::Contract;
 use crate::{assert_case_output_contains, assert_failed, assert_passed, test_case};
 use camino::Utf8PathBuf;
 use forge::run;

starknet-foundry/crates/forge/tests/integration/deploy.rs

@@ -1,10 +1,10 @@
-use crate::common::runner::Contract;
+use crate::integration::common::runner::Contract;
 use crate::{assert_passed, test_case};
 use camino::Utf8PathBuf;
 use std::path::Path;
 use std::string::ToString;
 
-use crate::common::corelib::{corelib, predeployed_contracts};
+use crate::integration::common::corelib::{corelib, predeployed_contracts};
 use forge::run;
 use indoc::indoc;
 

starknet-foundry/crates/forge/tests/integration/dispatchers.rs

@@ -0,0 +1,2 @@
+mod e2e;
+mod integration;