Refactor test dir structure (#2421)

* Move individual rust-oci-tests components in the tests dir We can use several things from test_framework and even integration_test for additional tests such as podman rootless and wasm tests Signed-off-by: Yashodhan Joshi <yjdoc2@gmail.com> * fix scripts and docs for the new dir structure Signed-off-by: Yashodhan Joshi <yjdoc2@gmail.com> --------- Signed-off-by: Yashodhan Joshi <yjdoc2@gmail.com>
youki-dev · Oct 10, 2023 · 80f1f36 · 80f1f36
1 parent 2cc0249
commit 80f1f36
Show file tree

Hide file tree

Showing 71 changed files with 20 additions and 18 deletions.
diff --git a/.github/workflows/integration_tests_validation.yaml b/.github/workflows/integration_tests_validation.yaml
@@ -22,7 +22,9 @@ jobs:
         with:
           files: |
             .github/workflows/integration_tests_validation.yaml
-            tests/rust-integration-tests/**
+            tests/runtimetest/**
+            tests/test_framework/**
+            tests/integration_test/**
           files_ignore: |
             **.md
       - name: List all changed files

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["tests/rust-integration-tests/*", "crates/*", "tools/*"]
+members = ["tests/runtimetest/","tests/integration_test/","tests/test_framework/","crates/*", "tools/*"]
 
 [profile.release]
 lto = true
diff --git a/docs/src/developer/e2e/integration_test.md b/docs/src/developer/e2e/integration_test.md
@@ -1,6 +1,6 @@
 # integration_test
 
-**Note** that these tests resides in `/tests/rust-integration-tests/integration_test/` at the time of writing.
+**Note** that these tests resides in `/tests/integration_test/` at the time of writing.
 
 This crate contains the Rust port of OCI-runtime tools integration tests, which are used to test if the runtime works as per the OCI spec or not. Initially youki used the original implementation of these test provided in the OCI repository [here](https://github.com/opencontainers/runtime-tools/tree/master/validation). But those tests are written in Go, which made the developers depend on two language environments Rust and Go to compile youki and test it. The Validation tests themselves also have an optional dependency on node js to parse their output, which can make it a third language dependency.
 

diff --git a/docs/src/developer/e2e/runtimetest.md b/docs/src/developer/e2e/runtimetest.md
@@ -1,6 +1,6 @@
 # Runtime Test
 
-**Note** that these tests resides in /tests/rust-integration-tests/runtimetest at the time of writing.
+**Note** that these tests resides in /tests/runtimetest at the time of writing.
 
 This crate provides a binary which is used by integration tests to verify that the restrictions and constraints applied to the container are upheld by the container process, from inside the container process. This runs the tests one-by-one, and the failing test prints the error to the stderr.
 

diff --git a/docs/src/developer/e2e/rust_oci_test.md b/docs/src/developer/e2e/rust_oci_test.md
@@ -19,7 +19,7 @@ We will not go into detail here, but will explain how to write and add a new tes
 <p>
 
 ```rust,no_run,noplayground
-{{#include ../../../../tests/rust-integration-tests/integration_test/src/tests/example/hello_world.rs}}
+{{#include ../../../../tests/integration_test/src/tests/example/hello_world.rs}}
 ```
 
 </p>
@@ -33,31 +33,31 @@ We will not go into detail here, but will explain how to write and add a new tes
     Therefore, it is common practice here to write an OCI Runtime Spec that executes `runtimetest`.
 
 ```rust,no_run,noplayground
-{{#include ../../../../tests/rust-integration-tests/integration_test/src/tests/example/hello_world.rs:get_example_spec}}
+{{#include ../../../../tests/integration_test/src/tests/example/hello_world.rs:get_example_spec}}
 ```
 
 2. Prepare a function that returns a `TestResult`, which represents the result of the test.
 
 ```rust,no_run,noplayground
-{{#include ../../../../tests/rust-integration-tests/integration_test/src/tests/example/hello_world.rs:example_test}}
+{{#include ../../../../tests/integration_test/src/tests/example/hello_world.rs:example_test}}
 ```
 
 3. Create a `TestGroup` and register a test case you created
 
 ```rust,no_run,noplayground
-{{#include ../../../../tests/rust-integration-tests/integration_test/src/tests/example/hello_world.rs:get_example_test}}
+{{#include ../../../../tests/integration_test/src/tests/example/hello_world.rs:get_example_test}}
 ```
 
 4. Register the `TestGroup` you created to a `TestManager`
 
 ```rust,no_run,noplayground
-{{#include ../../../../tests/rust-integration-tests/integration_test/src/main.rs:register_example_test}}
+{{#include ../../../../tests/integration_test/src/main.rs:register_example_test}}
 ```
 
 5. Write the validation you want to run within a test container
 ```rust,no_run,noplayground
-{{#include ../../../../tests/rust-integration-tests/runtimetest/src/main.rs:example_runtimetest_main}}
+{{#include ../../../../tests/runtimetest/src/main.rs:example_runtimetest_main}}
 ```
 ```rust,no_run,noplayground
-{{#include ../../../../tests/rust-integration-tests/runtimetest/src/tests.rs:example_hello_world}}
+{{#include ../../../../tests/runtimetest/src/tests.rs:example_hello_world}}
 ```
diff --git a/docs/src/developer/e2e/test_framework.md b/docs/src/developer/e2e/test_framework.md
@@ -1,6 +1,6 @@
 # test_framework
 
-**Note** that these tests resides in /tests/rust-integration-tests/test_framework at the time of writing.
+**Note** that these tests resides in /tests/test_framework at the time of writing.
 
 This crate contains the testing framework specifically developed for porting the OCI integration test to rust. This contains structs to represent the individual tests, group of tests and a test manager that has responsibility to run tests. This Also exposes traits which can be used to implement custom test structs or test group structs if needed.
 

diff --git a/docs/src/developer/runtimetest.md b/docs/src/developer/runtimetest.md
@@ -1,6 +1,6 @@
 # Runtime Test
 
-**Note** that these tests resides in /tests/rust-integration-tests/runtimetest at the time of writing.
+**Note** that these tests resides in /tests/runtimetest at the time of writing.
 
 This crate provides a binary which is used by integration tests to verify that the restrictions and constraints applied to the container are upheld by the container process, from inside the container process. This runs the tests one-by-one, and the failing test prints the error to the stderr.
 

diff --git a/scripts/rust_integration_tests.sh b/scripts/rust_integration_tests.sh
@@ -20,7 +20,7 @@ ROOT=${2-$(git rev-parse --show-toplevel)}
 LOGFILE="${ROOT}/test.log"
 
 if [ ! -f ${ROOT}/bundle.tar.gz ]; then
-    cp ${ROOT}/tests/rust-integration-tests/integration_test/bundle.tar.gz ${ROOT}/bundle.tar.gz
+    cp ${ROOT}/tests/integration_test/bundle.tar.gz ${ROOT}/bundle.tar.gz
 fi
 touch ${LOGFILE}
 

diff --git a/tests/rust-integration-tests/.gitignore → tests/.gitignore b/tests/rust-integration-tests/.gitignore → tests/.gitignore
diff --git a/...gration-tests/integration_test/.gitignore → tests/integration_test/.gitignore b/...gration-tests/integration_test/.gitignore → tests/integration_test/.gitignore
diff --git a/...gration-tests/integration_test/Cargo.toml → tests/integration_test/Cargo.toml b/...gration-tests/integration_test/Cargo.toml → tests/integration_test/Cargo.toml
@@ -7,8 +7,8 @@ edition = "2021"
 anyhow = "1.0"
 chrono = { version = "0.4", default-features = false, features = ["clock"] }
 flate2 = "1.0"
-libcgroups = { path = "../../../crates/libcgroups" }
-libcontainer = { path = "../../../crates/libcontainer" }
+libcgroups = { path = "../../crates/libcgroups" }
+libcontainer = { path = "../../crates/libcontainer" }
 nix = "0.27.1"
 num_cpus = "1.16"
 oci-spec = { version = "0.6.1", features = ["runtime"] }

diff --git a/...egration-tests/integration_test/README.md → tests/integration_test/README.md b/...egration-tests/integration_test/README.md → tests/integration_test/README.md
diff --git a/...tion-tests/integration_test/bundle.tar.gz → tests/integration_test/bundle.tar.gz b/...tion-tests/integration_test/bundle.tar.gz → tests/integration_test/bundle.tar.gz
diff --git a/...gration-tests/integration_test/src/lib.rs → tests/integration_test/src/lib.rs b/...gration-tests/integration_test/src/lib.rs → tests/integration_test/src/lib.rs
diff --git a/...tion-tests/integration_test/src/logger.rs → tests/integration_test/src/logger.rs b/...tion-tests/integration_test/src/logger.rs → tests/integration_test/src/logger.rs
diff --git a/...ration-tests/integration_test/src/main.rs → tests/integration_test/src/main.rs b/...ration-tests/integration_test/src/main.rs → tests/integration_test/src/main.rs
diff --git a/...tegration_test/src/tests/cgroups/blkio.rs → ...tegration_test/src/tests/cgroups/blkio.rs b/...tegration_test/src/tests/cgroups/blkio.rs → ...tegration_test/src/tests/cgroups/blkio.rs
diff --git a/...gration_test/src/tests/cgroups/cpu/mod.rs → ...gration_test/src/tests/cgroups/cpu/mod.rs b/...gration_test/src/tests/cgroups/cpu/mod.rs → ...gration_test/src/tests/cgroups/cpu/mod.rs
diff --git a/...egration_test/src/tests/cgroups/cpu/v1.rs → ...egration_test/src/tests/cgroups/cpu/v1.rs b/...egration_test/src/tests/cgroups/cpu/v1.rs → ...egration_test/src/tests/cgroups/cpu/v1.rs
diff --git a/...egration_test/src/tests/cgroups/cpu/v2.rs → ...egration_test/src/tests/cgroups/cpu/v2.rs b/...egration_test/src/tests/cgroups/cpu/v2.rs → ...egration_test/src/tests/cgroups/cpu/v2.rs
diff --git a/...egration_test/src/tests/cgroups/memory.rs → ...egration_test/src/tests/cgroups/memory.rs b/...egration_test/src/tests/cgroups/memory.rs → ...egration_test/src/tests/cgroups/memory.rs
diff --git a/...integration_test/src/tests/cgroups/mod.rs → ...integration_test/src/tests/cgroups/mod.rs b/...integration_test/src/tests/cgroups/mod.rs → ...integration_test/src/tests/cgroups/mod.rs
diff --git a/...gration_test/src/tests/cgroups/network.rs → ...gration_test/src/tests/cgroups/network.rs b/...gration_test/src/tests/cgroups/network.rs → ...gration_test/src/tests/cgroups/network.rs
diff --git a/...ntegration_test/src/tests/cgroups/pids.rs → ...ntegration_test/src/tests/cgroups/pids.rs b/...ntegration_test/src/tests/cgroups/pids.rs → ...ntegration_test/src/tests/cgroups/pids.rs
diff --git a/...ion_test/src/tests/example/hello_world.rs → ...ion_test/src/tests/example/hello_world.rs b/...ion_test/src/tests/example/hello_world.rs → ...ion_test/src/tests/example/hello_world.rs
diff --git a/...integration_test/src/tests/example/mod.rs → ...integration_test/src/tests/example/mod.rs b/...integration_test/src/tests/example/mod.rs → ...integration_test/src/tests/example/mod.rs
diff --git a/...ntegration_test/src/tests/hooks/invoke.rs → ...ntegration_test/src/tests/hooks/invoke.rs b/...ntegration_test/src/tests/hooks/invoke.rs → ...ntegration_test/src/tests/hooks/invoke.rs
diff --git a/...s/integration_test/src/tests/hooks/mod.rs → ...s/integration_test/src/tests/hooks/mod.rs b/...s/integration_test/src/tests/hooks/mod.rs → ...s/integration_test/src/tests/hooks/mod.rs
diff --git a/...ntegration_test/src/tests/hostname/mod.rs → ...ntegration_test/src/tests/hostname/mod.rs b/...ntegration_test/src/tests/hostname/mod.rs → ...ntegration_test/src/tests/hostname/mod.rs
diff --git a/...est/src/tests/intel_rdt/intel_rdt_test.rs → ...est/src/tests/intel_rdt/intel_rdt_test.rs b/...est/src/tests/intel_rdt/intel_rdt_test.rs → ...est/src/tests/intel_rdt/intel_rdt_test.rs
diff --git a/...tegration_test/src/tests/intel_rdt/mod.rs → ...tegration_test/src/tests/intel_rdt/mod.rs b/...tegration_test/src/tests/intel_rdt/mod.rs → ...tegration_test/src/tests/intel_rdt/mod.rs
diff --git a/...on_test/src/tests/lifecycle/checkpoint.rs → ...on_test/src/tests/lifecycle/checkpoint.rs b/...on_test/src/tests/lifecycle/checkpoint.rs → ...on_test/src/tests/lifecycle/checkpoint.rs
diff --git a/...t/src/tests/lifecycle/container_create.rs → ...t/src/tests/lifecycle/container_create.rs b/...t/src/tests/lifecycle/container_create.rs → ...t/src/tests/lifecycle/container_create.rs
diff --git a/...rc/tests/lifecycle/container_lifecycle.rs → ...rc/tests/lifecycle/container_lifecycle.rs b/...rc/tests/lifecycle/container_lifecycle.rs → ...rc/tests/lifecycle/container_lifecycle.rs
diff --git a/...ration_test/src/tests/lifecycle/create.rs → ...ration_test/src/tests/lifecycle/create.rs b/...ration_test/src/tests/lifecycle/create.rs → ...ration_test/src/tests/lifecycle/create.rs
diff --git a/...ration_test/src/tests/lifecycle/delete.rs → ...ration_test/src/tests/lifecycle/delete.rs b/...ration_test/src/tests/lifecycle/delete.rs → ...ration_test/src/tests/lifecycle/delete.rs
diff --git a/...egration_test/src/tests/lifecycle/exec.rs → ...egration_test/src/tests/lifecycle/exec.rs b/...egration_test/src/tests/lifecycle/exec.rs → ...egration_test/src/tests/lifecycle/exec.rs
diff --git a/...egration_test/src/tests/lifecycle/kill.rs → ...egration_test/src/tests/lifecycle/kill.rs b/...egration_test/src/tests/lifecycle/kill.rs → ...egration_test/src/tests/lifecycle/kill.rs
diff --git a/...tegration_test/src/tests/lifecycle/mod.rs → ...tegration_test/src/tests/lifecycle/mod.rs b/...tegration_test/src/tests/lifecycle/mod.rs → ...tegration_test/src/tests/lifecycle/mod.rs
diff --git a/...gration_test/src/tests/lifecycle/start.rs → ...gration_test/src/tests/lifecycle/start.rs b/...gration_test/src/tests/lifecycle/start.rs → ...gration_test/src/tests/lifecycle/start.rs
diff --git a/...gration_test/src/tests/lifecycle/state.rs → ...gration_test/src/tests/lifecycle/state.rs b/...gration_test/src/tests/lifecycle/state.rs → ...gration_test/src/tests/lifecycle/state.rs
diff --git a/...egration_test/src/tests/lifecycle/util.rs → ...egration_test/src/tests/lifecycle/util.rs b/...egration_test/src/tests/lifecycle/util.rs → ...egration_test/src/tests/lifecycle/util.rs
diff --git a/...tion_test/src/tests/linux_ns_itype/mod.rs → ...tion_test/src/tests/linux_ns_itype/mod.rs b/...tion_test/src/tests/linux_ns_itype/mod.rs → ...tion_test/src/tests/linux_ns_itype/mod.rs
diff --git a/...src/tests/linux_ns_itype/ns_itype_test.rs → ...src/tests/linux_ns_itype/ns_itype_test.rs b/...src/tests/linux_ns_itype/ns_itype_test.rs → ...src/tests/linux_ns_itype/ns_itype_test.rs
diff --git a/...n-tests/integration_test/src/tests/mod.rs → tests/integration_test/src/tests/mod.rs b/...n-tests/integration_test/src/tests/mod.rs → tests/integration_test/src/tests/mod.rs
diff --git a/...on_test/src/tests/mounts_recursive/mod.rs → ...on_test/src/tests/mounts_recursive/mod.rs b/...on_test/src/tests/mounts_recursive/mod.rs → ...on_test/src/tests/mounts_recursive/mod.rs
@@ -605,9 +605,9 @@ fn check_recursive_rsymfollow() -> TestResult {
 
 /// this mount test how to work?
 /// 1. Create mount_options based on the mount properties of the test
-/// 2. Create OCI.Spec content, container one process is runtimetest,(runtimetest is cargo model, file path `tests/rust-integration-tests/runtimetest/`)
+/// 2. Create OCI.Spec content, container one process is runtimetest,(runtimetest is cargo model, file path `tests/runtimetest/`)
 /// 3. inside container to check if the actual mount matches the spec, (spec https://man7.org/linux/man-pages/man2/mount_setattr.2.html),
-///  eg. tests/rust-integration-tests/runtimetest/src/tests.rs
+///  eg. tests/runtimetest/src/tests.rs
 pub fn get_mounts_recursive_test() -> TestGroup {
     let rro_test = Test::new("rro_test", Box::new(check_recursive_readonly));
     let rnosuid_test = Test::new("rnosuid_test", Box::new(check_recursive_nosuid));

diff --git a/...integration_test/src/tests/pidfile/mod.rs → ...integration_test/src/tests/pidfile/mod.rs b/...integration_test/src/tests/pidfile/mod.rs → ...integration_test/src/tests/pidfile/mod.rs
diff --git a/...on_test/src/tests/pidfile/pidfile_test.rs → ...on_test/src/tests/pidfile/pidfile_test.rs b/...on_test/src/tests/pidfile/pidfile_test.rs → ...on_test/src/tests/pidfile/pidfile_test.rs
diff --git a/...tion_test/src/tests/readonly_paths/mod.rs → ...tion_test/src/tests/readonly_paths/mod.rs b/...tion_test/src/tests/readonly_paths/mod.rs → ...tion_test/src/tests/readonly_paths/mod.rs
diff --git a/...ts/readonly_paths/readonly_paths_tests.rs → ...ts/readonly_paths/readonly_paths_tests.rs b/...ts/readonly_paths/readonly_paths_tests.rs → ...ts/readonly_paths/readonly_paths_tests.rs
diff --git a/...tion_test/src/tests/seccomp_notify/mod.rs → ...tion_test/src/tests/seccomp_notify/mod.rs b/...tion_test/src/tests/seccomp_notify/mod.rs → ...tion_test/src/tests/seccomp_notify/mod.rs
diff --git a/...src/tests/seccomp_notify/seccomp_agent.rs → ...src/tests/seccomp_notify/seccomp_agent.rs b/...src/tests/seccomp_notify/seccomp_agent.rs → ...src/tests/seccomp_notify/seccomp_agent.rs
diff --git a/...sts/integration_test/src/tests/tlb/mod.rs → tests/integration_test/src/tests/tlb/mod.rs b/...sts/integration_test/src/tests/tlb/mod.rs → tests/integration_test/src/tests/tlb/mod.rs
diff --git a/...ntegration_test/src/tests/tlb/tlb_test.rs → ...ntegration_test/src/tests/tlb/tlb_test.rs b/...ntegration_test/src/tests/tlb/tlb_test.rs → ...ntegration_test/src/tests/tlb/tlb_test.rs
diff --git a/...n-tests/integration_test/src/utils/mod.rs → tests/integration_test/src/utils/mod.rs b/...n-tests/integration_test/src/utils/mod.rs → tests/integration_test/src/utils/mod.rs
diff --git a/...sts/integration_test/src/utils/support.rs → tests/integration_test/src/utils/support.rs b/...sts/integration_test/src/utils/support.rs → tests/integration_test/src/utils/support.rs
diff --git a/.../integration_test/src/utils/test_utils.rs → .../integration_test/src/utils/test_utils.rs b/.../integration_test/src/utils/test_utils.rs → .../integration_test/src/utils/test_utils.rs
diff --git a/...tion-tests/runtimetest/.cargo/config.toml → tests/runtimetest/.cargo/config.toml b/...tion-tests/runtimetest/.cargo/config.toml → tests/runtimetest/.cargo/config.toml
diff --git a/...-integration-tests/runtimetest/Cargo.toml → tests/runtimetest/Cargo.toml b/...-integration-tests/runtimetest/Cargo.toml → tests/runtimetest/Cargo.toml
diff --git a/...t-integration-tests/runtimetest/README.md → tests/runtimetest/README.md b/...t-integration-tests/runtimetest/README.md → tests/runtimetest/README.md
diff --git a/...integration-tests/runtimetest/src/main.rs → tests/runtimetest/src/main.rs b/...integration-tests/runtimetest/src/main.rs → tests/runtimetest/src/main.rs
diff --git a/...ntegration-tests/runtimetest/src/tests.rs → tests/runtimetest/src/tests.rs b/...ntegration-tests/runtimetest/src/tests.rs → tests/runtimetest/src/tests.rs
diff --git a/...ntegration-tests/runtimetest/src/utils.rs → tests/runtimetest/src/utils.rs b/...ntegration-tests/runtimetest/src/utils.rs → tests/runtimetest/src/utils.rs
diff --git a/...tegration-tests/test_framework/Cargo.toml → tests/test_framework/Cargo.toml b/...tegration-tests/test_framework/Cargo.toml → tests/test_framework/Cargo.toml
diff --git a/...ntegration-tests/test_framework/README.md → tests/test_framework/README.md b/...ntegration-tests/test_framework/README.md → tests/test_framework/README.md
diff --git a/...ts/test_framework/src/conditional_test.rs → tests/test_framework/src/conditional_test.rs b/...ts/test_framework/src/conditional_test.rs → tests/test_framework/src/conditional_test.rs
diff --git a/...tegration-tests/test_framework/src/lib.rs → tests/test_framework/src/lib.rs b/...tegration-tests/test_framework/src/lib.rs → tests/test_framework/src/lib.rs
diff --git a/...egration-tests/test_framework/src/test.rs → tests/test_framework/src/test.rs b/...egration-tests/test_framework/src/test.rs → tests/test_framework/src/test.rs
diff --git a/...on-tests/test_framework/src/test_group.rs → tests/test_framework/src/test_group.rs b/...on-tests/test_framework/src/test_group.rs → tests/test_framework/src/test_group.rs
diff --git a/...-tests/test_framework/src/test_manager.rs → tests/test_framework/src/test_manager.rs b/...-tests/test_framework/src/test_manager.rs → tests/test_framework/src/test_manager.rs
diff --git a/...tion-tests/test_framework/src/testable.rs → tests/test_framework/src/testable.rs b/...tion-tests/test_framework/src/testable.rs → tests/test_framework/src/testable.rs