Workspaces

.github/workflows/code-quality.yml

@@ -2,7 +2,7 @@ name: Code quality and sanity
 
 on:
   push:
-    branches: '*'
+    branches: 'main'
   pull_request:
     branches: '*'
 
@@ -22,12 +22,12 @@ jobs:
       - uses: hecrj/setup-rust-action@v1
         with:
           components: clippy
-      
-      - name: Verifiying the code quality with Clippy 
+
+      - name: Verifiying the code quality with Clippy
         run: |
           cd zork++
           cargo clippy --all-targets --all-features
-  
+
   rustfmt:
     name: Verify code formatting
     runs-on: ubuntu-latest
@@ -36,51 +36,17 @@ jobs:
       - name: Caching project dependencies
         id: project-cache
         uses: Swatinem/rust-cache@v2
-      - uses: hecrj/setup-rust-action@v1
+
+      - uses: hecrj/setup-rust-action@v2
         with:
           components: rustfmt
+
       - name: Checking the format sanity of the project
         run: |
           cd zork++
           cargo fmt --all -- --check
 
-  tests:
-    name: Run the tests - Clang 
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        clang_version: [15, 16, 17]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Caching project dependencies
-        id: project-cache
-        uses: Swatinem/rust-cache@v2
-      - name: Install Clang ${{ matrix.clang_version }}
-        run: |
-          # Exit on error
-          set -e
-          # Download and execute the LLVM installation script for the specified Clang version
-          echo "-----> Downloading and executing the LLVM installation script for Clang ${{ matrix.clang_version }}"
-          wget https://apt.llvm.org/llvm.sh
-          chmod +x llvm.sh
-          sudo ./llvm.sh ${{ matrix.clang_version }}
-
-          echo "-----> Installing libc++"
-          sudo apt-get install -y libc++-${{ matrix.clang_version }}-dev libc++abi-${{ matrix.clang_version }}-dev libunwind-${{ matrix.clang_version }} libunwind-${{ matrix.clang_version }}-dev libc6 libzstd1
-
-          # Update the symbolic link to point to the newly installed Clang version
-          echo "-----> Updating the symbolic link to point to Clang ${{ matrix.clang_version }}"
-          sudo rm -f /usr/bin/clang++
-          sudo ln -s /usr/bin/clang++-${{ matrix.clang_version }} /usr/bin/clang++
-
-
-          # Display the installation directory and version of the installed Clang
-          echo "-----> Clang-${{ matrix.clang_version }} was installed on:"
-          which clang-${{ matrix.clang_version }}
-          echo "-----> Clang++ was installed on:"
-          which clang++-${{ matrix.clang_version }}
-      - name: Running the tests for the project
+      - name: Run Unit and Doc tests
         run: |
-          cd zork++
-          RUST_LOG=trace cargo test 2>&1 --all --color=always --no-fail-fast -- --nocapture --show-output --test-threads=1
+          cargo test --workspace --lib --color=always --no-fail-fast
+          cargo test --workspace --doc --color=always --no-fail-fast

.github/workflows/tests-clang-linux.yml

@@ -0,0 +1,52 @@
+name: Clang Tests For Linux builds
+
+on:
+  push:
+    branches: 'main'
+  pull_request:
+    branches: '*'
+
+jobs:
+  tests:
+    name: Run the tests - Clang
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        clang_version: [15, 16, 17, 18]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Caching project dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - if: ${{ matrix.clang_version < 18 }}
+        name: Install Clang ${{ matrix.clang_version }}
+        run: |
+          # Exit on error
+          set -e
+          # Download and execute the LLVM installation script for the specified Clang version
+          echo "-----> Downloading and executing the LLVM installation script for Clang ${{ matrix.clang_version }}"
+          wget https://apt.llvm.org/llvm.sh
+          chmod +x llvm.sh
+          sudo ./llvm.sh ${{ matrix.clang_version }}
+
+          echo "-----> Installing libc++"
+          sudo apt-get install -y libc++-${{ matrix.clang_version }}-dev libc++abi-${{ matrix.clang_version }}-dev libunwind-${{ matrix.clang_version }} libunwind-${{ matrix.clang_version }}-dev libc6 libzstd1
+
+          # Update the symbolic link to point to the newly installed Clang version
+          echo "-----> Updating the symbolic link to point to Clang ${{ matrix.clang_version }}"
+          sudo rm -f /usr/bin/clang++
+          sudo ln -s /usr/bin/clang++-${{ matrix.clang_version }} /usr/bin/clang++
+
+          # Display the installation directory and version of the installed Clang
+          echo "-----> Clang-${{ matrix.clang_version }} was installed on:"
+          which clang-${{ matrix.clang_version }}
+          echo "-----> Clang++ was installed on:"
+          which clang++-${{ matrix.clang_version }}
+
+      - if: ${{ matrix.clang_version < 18 }}
+        name: Running the tests for the project
+        run: |
+          cd zork++
+          RUST_LOG=trace cargo test 2>&1 clang --color=always --no-fail-fast -- --nocapture --show-output --test-threads=1

.github/workflows/tests-gcc.yml

@@ -0,0 +1,25 @@
+name: GCC Tests For Linux builds
+
+on:
+  push:
+    branches: 'main'
+  pull_request:
+    branches: '*'
+
+jobs:
+  tests:
+    name: Run the tests - GCC
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Caching project dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - name: Running the tests for the project
+        run: |
+          cd zork++
+          RUST_LOG=trace cargo test 2>&1 gcc --color=always --no-fail-fast -- --nocapture --show-output --test-threads=1

.github/workflows/tests-msvc.yml

@@ -0,0 +1,30 @@
+name: MSVC Tests For Windows builds
+
+on:
+  push:
+    branches: 'main'
+  pull_request:
+    branches: '*'
+
+jobs:
+  tests:
+    name: Run the tests - MSVC
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Caching project dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - name: Setting up Rust
+        uses: hecrj/setup-rust-action@v1
+        with:
+          rust-version: stable
+
+      - name: Running the tests for the project
+        run: |
+          cd zork++
+          cargo test 2>&1 msvc --color=always --no-fail-fast -- --nocapture --show-output --test-threads=1

zork++/src/lib/cache/mod.rs

@@ -204,7 +204,7 @@ impl ZorkCache {
             .entry(PathBuf::from(named_target))
             .and_modify(|e| {
                 if !(*e).eq(&commands_details.main.command) {
-                    *e = commands_details.main.command.clone()
+                    e.clone_from(&commands_details.main.command)
                 }
             })
             .or_insert(commands_details.main.command.clone());

zork++/src/lib/config_file/build.rs

@@ -23,7 +23,7 @@ use serde::*;
 ///
 /// assert_eq!(config.output_dir, Some("out"));
 /// ```
-#[derive(Deserialize, Debug, PartialEq)]
+#[derive(Deserialize, Debug, PartialEq, Clone)]
 #[serde(deny_unknown_fields)]
 pub struct BuildAttribute<'a> {
     #[serde(borrow)]

zork++/src/lib/config_file/compiler.rs

@@ -66,7 +66,7 @@ use crate::project_model;
 ///
 /// For a test over a real example, please look at the
 /// [`zork::config_file::ZorkConfigFile`] doc-test
-#[derive(Deserialize, Debug, PartialEq, Default)]
+#[derive(Deserialize, Debug, PartialEq, Default, Clone)]
 #[serde(deny_unknown_fields)]
 pub struct CompilerAttribute<'a> {
     pub cpp_compiler: CppCompiler,

zork++/src/lib/config_file/mod.rs

@@ -6,9 +6,11 @@ pub mod executable;
 pub mod modules;
 pub mod project;
 pub mod tests;
+pub mod workspace;
 
 use std::fmt::Debug;
 
+use crate::config_file::workspace::WorkspaceAttribute;
 use serde::Deserialize;
 
 use self::{
@@ -42,8 +44,10 @@ use self::{
 /// The [`ZorkConfigFile`] is the type that holds
 /// the whole hierarchy of Zork++ config file attributes
 /// and properties
-#[derive(Deserialize, Debug, Default)]
+#[derive(Deserialize, Debug, Default, Clone)]
 pub struct ZorkConfigFile<'a> {
+    #[serde(borrow)]
+    pub workspace: Option<WorkspaceAttribute<'a>>,
     #[serde(borrow)]
     pub project: ProjectAttribute<'a>,
     #[serde(borrow)]

zork++/src/lib/config_file/modules.rs

@@ -59,7 +59,7 @@ use serde::Deserialize;
 /// assert_eq!(&gcc_sys_headers[3], &"type_traits");
 /// assert_eq!(&gcc_sys_headers[4], &"functional");
 /// ```
-#[derive(Deserialize, Debug, PartialEq)]
+#[derive(Deserialize, Debug, PartialEq, Clone)]
 pub struct ModulesAttribute<'a> {
     #[serde(borrow)]
     pub base_ifcs_dir: Option<&'a str>,
@@ -132,7 +132,7 @@ pub struct ModulesAttribute<'a> {
 /// assert_eq!(ifc_3.file, "some_module_part.cppm");
 /// assert_eq!(ifc_3.module_name, Some("math_part"));
 /// ```
-#[derive(Deserialize, Debug, PartialEq)]
+#[derive(Deserialize, Debug, PartialEq, Clone)]
 #[serde(deny_unknown_fields)]
 pub struct ModuleInterface<'a> {
     #[serde(borrow)]
@@ -158,7 +158,7 @@ pub struct ModuleInterface<'a> {
 /// * `is_internal_partition` - Optional field for declare that the module is actually
 /// a module for hold implementation details, known as module implementation partitions.
 /// This option only takes effect with MSVC
-#[derive(Deserialize, Debug, PartialEq)]
+#[derive(Deserialize, Debug, PartialEq, Clone)]
 pub struct ModulePartition<'a> {
     #[serde(borrow)]
     pub module: &'a str,
@@ -200,7 +200,7 @@ pub struct ModulePartition<'a> {
 /// assert_eq!(deps[1], "type_traits");
 /// assert_eq!(deps[2], "iostream");
 /// ```
-#[derive(Deserialize, Debug, PartialEq)]
+#[derive(Deserialize, Debug, PartialEq, Clone)]
 pub struct ModuleImplementation<'a> {
     #[serde(borrow)]
     pub file: &'a str,

zork++/src/lib/config_file/project.rs

@@ -35,7 +35,7 @@ use serde::*;
 ///
 /// For a test over a real example, please look at the
 /// [`zork::config_file::ZorkConfigFile`] doc-test
-#[derive(Deserialize, Debug, PartialEq, Default)]
+#[derive(Deserialize, Debug, PartialEq, Default, Clone)]
 #[serde(deny_unknown_fields)]
 pub struct ProjectAttribute<'a> {
     pub name: &'a str,

zork++/src/lib/config_file/tests.rs

@@ -38,7 +38,7 @@ use serde::*;
 ///
 /// For a test over a real example, please look at the
 /// [`zork::config_file::ZorkConfigFile`] doc-test
-#[derive(Deserialize, Debug, PartialEq)]
+#[derive(Deserialize, Debug, PartialEq, Clone)]
 pub struct TestsAttribute<'a> {
     #[serde(borrow)]
     pub test_executable_name: Option<&'a str>,

zork++/src/lib/config_file/workspace.rs

@@ -0,0 +1,39 @@
+use serde::Deserialize;
+
+/// [`WorkspaceAttribute`] - Defines the characteristics of a `Zork++` workspace.
+///
+/// A `Zork++` workspace is a similar concept to Cargo workspaces, where the managed by
+/// the workspace collection of projects shares dependencies, a common output directory,
+/// metadata attributes... Commands applied to a workspace are propagated down to the
+/// workspace members.
+///
+/// This allows the user to divide a project into smaller pieces, or create new organization
+/// structures for more complex configurations.
+///
+/// * `members` - A collection of the names by which the dependent projects (every member of the ws)
+/// has been defined in their own `zork**.toml` config file in the **project_name** key
+///
+/// ### Tests
+///
+/// ```rust
+/// use zork::config_file::workspace::{
+///     WorkspaceAttribute
+/// };
+///
+
+/// ```
+///
+/// > Note: TOML table are toml commented (#) to allow us to parse
+/// the inner attributes as the direct type that they belongs to.
+/// That commented tables aren't the real TOML, they are just there
+/// for testing and exemplification purposes of the inner attributes
+/// of the configuration file.
+///
+/// For a test over a real example, please look at the
+/// [`zork::config_file::ZorkConfigFile`] doc-test
+#[derive(Deserialize, Debug, PartialEq, Default, Clone)]
+#[serde(deny_unknown_fields)]
+pub struct WorkspaceAttribute<'a> {
+    #[serde(borrow)]
+    pub members: Vec<&'a str>,
+}