Split rust-tooling into separate crates (#1795)

TL;DR: This makes CI faster.

The main advantage of splitting the tooling into several crates is that
the CI tests only need to compile the dependencies needed for them.
Notably, that excludes Tera, which is used for exercise generation. This
also paves the way for making the exercise generator more rich, using
potentially compile-time heavy crates (e.g. `clap`).

.github/workflows/tests.yml

@@ -92,7 +92,7 @@ jobs:
           toolchain: stable
 
       - name: Run tests
-        run: cd rust-tooling && cargo test
+        run: cd rust-tooling/ci-tests && cargo test
 
   rustformat:
     name: Check Rust Formatting

rust-tooling/Cargo.toml

@@ -1,17 +1,3 @@
-[package]
-name = "exercism_tooling"
-version = "0.1.0"
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-convert_case = "0.6.0"
-glob = "0.3.1"
-ignore = "0.4.20"
-inquire = "0.6.2"
-once_cell = "1.18.0"
-serde = { version = "1.0.188", features = ["derive"] }
-serde_json = { version = "1.0.105", features = ["preserve_order"] }
-tera = "1.19.1"
-uuid = { version = "1.4.1", features = ["v4"] }
+[workspace]
+members = ["generator", "ci-tests", "utils", "models"]
+resolver = "2"

rust-tooling/ci-tests/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "ci-tests"
+version = "0.1.0"
+edition = "2021"
+description = "Tests to be run in CI to make sure the repo is in good shape"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+# This crate is built in CI to run the tests.
+# Be considerate when adding dependencies to keep compile times reasonable.
+[dependencies]
+convert_case = "0.6.0"
+ignore = "0.4.20"
+models = { version = "0.1.0", path = "../models" }
+serde_json = "1.0.108"
+utils = { version = "0.1.0", path = "../utils" }

rust-tooling/ci-tests/src/lib.rs

@@ -0,0 +1,5 @@
+//! dummy lib.rs
+//!
+//! This crate only exists for the tests.
+//! The lib.rs may be used for shared code amoung the tests,
+//! if that ever turns out to be useful.

rust-tooling/tests/bash_script_conventions.rs → rust-tooling/ci-tests/tests/bash_script_conventions.rs

@@ -1,12 +1,11 @@
 use std::path::PathBuf;
 
 use convert_case::{Case, Casing};
-use exercism_tooling::fs_utils;
 
 /// Runs a function for each bash script in the bin directory.
 /// The function is passed the path of the script.
 fn for_all_scripts(f: fn(&str)) {
-    fs_utils::cd_into_repo_root();
+    utils::fs::cd_into_repo_root();
 
     for entry in std::fs::read_dir("bin").unwrap() {
         let path = entry.unwrap().path();

rust-tooling/tests/count_ignores.rs → rust-tooling/ci-tests/tests/count_ignores.rs

@@ -1,4 +1,4 @@
-use exercism_tooling::exercise_config::{
+use models::exercise_config::{
     get_all_concept_exercise_paths, get_all_practice_exercise_paths, PracticeExercise,
 };
 

rust-tooling/tests/difficulties.rs → rust-tooling/ci-tests/tests/difficulties.rs

@@ -1,6 +1,6 @@
 //! Make sure exercise difficulties are set correctly
 
-use exercism_tooling::track_config::TRACK_CONFIG;
+use models::track_config::TRACK_CONFIG;
 
 #[test]
 fn difficulties_are_valid() {

rust-tooling/tests/no_authors_in_cargo_toml.rs → rust-tooling/ci-tests/tests/no_authors_in_cargo_toml.rs

@@ -1,4 +1,4 @@
-use exercism_tooling::exercise_config::get_all_exercise_paths;
+use models::exercise_config::get_all_exercise_paths;
 
 /// The package manifest of each exercise should not contain an `authors` field.
 /// The authors are already specified in the track configuration.

rust-tooling/tests/no_trailing_whitespace.rs → rust-tooling/ci-tests/tests/no_trailing_whitespace.rs

@@ -1,7 +1,5 @@
 use std::path::Path;
 
-use exercism_tooling::fs_utils;
-
 fn contains_trailing_whitespace(p: &Path) -> bool {
     let contents = std::fs::read_to_string(p).unwrap();
     for line in contents.lines() {
@@ -14,7 +12,7 @@ fn contains_trailing_whitespace(p: &Path) -> bool {
 
 #[test]
 fn no_trailing_whitespace() {
-    fs_utils::cd_into_repo_root();
+    utils::fs::cd_into_repo_root();
 
     for entry in ignore::Walk::new("./") {
         let entry = entry.unwrap();

rust-tooling/generator/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "generator"
+version = "0.1.0"
+edition = "2021"
+description = "Generates exercise boilerplate, especially test cases"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+convert_case = "0.6.0"
+glob = "0.3.1"
+inquire = "0.6.2"
+models = { version = "0.1.0", path = "../models" }
+serde_json = { version = "1.0.105", features = ["preserve_order"] }
+tera = "1.19.1"
+utils = { version = "0.1.0", path = "../utils" }
+uuid = { version = "1.4.1", features = ["v4"] }

rust-tooling/src/bin/generate_exercise.rs → rust-tooling/generator/src/bin/generate_exercise.rs

@@ -1,12 +1,10 @@
 use std::path::PathBuf;
 
 use convert_case::{Case, Casing};
-use exercism_tooling::{
-    exercise_generation, fs_utils,
-    track_config::{self, TRACK_CONFIG},
-};
+use generator::exercise_generation;
 use glob::glob;
 use inquire::{validator::Validation, Select, Text};
+use models::track_config::{self, TRACK_CONFIG};
 
 enum Difficulty {
     Easy,
@@ -39,7 +37,7 @@ impl std::fmt::Display for Difficulty {
 }
 
 fn main() {
-    fs_utils::cd_into_repo_root();
+    utils::fs::cd_into_repo_root();
 
     let is_update = std::env::args().any(|arg| arg == "update");
 

rust-tooling/src/exercise_generation.rs → rust-tooling/generator/src/exercise_generation.rs

@@ -4,10 +4,10 @@ use std::{
     process::{Command, Stdio},
 };
 
-use tera::Context;
+use tera::{Context, Tera};
 
-use crate::{
-    exercise_config::{get_excluded_tests, get_test_emplate},
+use models::{
+    exercise_config::get_excluded_tests,
     problem_spec::{get_additional_test_cases, get_canonical_data, SingleTestCase, TestCase},
 };
 
@@ -76,7 +76,7 @@ fn generate_example_rs(fn_name: &str) -> String {
     )
 }
 
-static TEST_TEMPLATE: &str = include_str!("default_test_template.tera");
+static TEST_TEMPLATE: &str = include_str!("../default_test_template.tera");
 
 fn extend_single_cases(single_cases: &mut Vec<SingleTestCase>, cases: Vec<TestCase>) {
     for case in cases {
@@ -101,7 +101,7 @@ fn generate_tests(slug: &str, fn_names: Vec<String>) -> String {
         cases
     };
     let excluded_tests = get_excluded_tests(slug);
-    let mut template = get_test_emplate(slug).unwrap();
+    let mut template = get_test_template(slug).unwrap();
     if template.get_template_names().next().is_none() {
         template
             .add_raw_template("test_template.tera", TEST_TEMPLATE)
@@ -143,3 +143,7 @@ fn generate_tests(slug: &str, fn_names: Vec<String>) -> String {
         rendered.into()
     }
 }
+
+pub fn get_test_template(slug: &str) -> Option<Tera> {
+    Some(Tera::new(format!("exercises/practice/{slug}/.meta/*.tera").as_str()).unwrap())
+}

rust-tooling/generator/src/lib.rs

@@ -0,0 +1 @@
+pub mod exercise_generation;

rust-tooling/models/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "models"
+version = "0.1.0"
+edition = "2021"
+description = "Data structures for exercism stuff"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+ignore = "0.4.20"
+once_cell = "1.18.0"
+serde = { version = "1.0.188", features = ["derive"] }
+serde_json = { version = "1.0.105", features = ["preserve_order"] }
+utils = { version = "0.1.0", path = "../utils" }
+uuid = { version = "1.6.1", features = ["v4"] }