Merge #356

356: Move integration tests to a separate workspace crate to avoid MSRV is… r=Ogeon a=Ogeon Due to [an MSRV bump in `memchr`](BurntSushi/memchr@e1f72c6), I decided to move the integration tests to their own workspace crate. Co-authored-by: Erik Hedvall <[email protected]>
Ogeon · Sep 9, 2023 · bae6ab5 · bae6ab5
2 parents 8a2fbfa + ffcab42
commit bae6ab5
Show file tree

Hide file tree

Showing 40 changed files with 61 additions and 26 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -27,10 +27,10 @@ jobs:
           cache-target: release
           bins: cargo-codspeed
       - name: Build the benchmark target(s)
-        run: cargo codspeed build -p benchmarks
+        run: cargo codspeed build -p benchmarks --features all_features
       - name: Run the benchmarks
         uses: CodSpeedHQ/action@v1
         with:
           run: cargo codspeed run
-          working-directory: palette # mimics how tests work, so the colors CSV can be found
+          working-directory: integration_tests # mimics how tests work, so the colors CSV can be found
           token: ${{ secrets.CODSPEED_TOKEN }}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -36,6 +36,19 @@ jobs:
         shell: bash
         working-directory: palette
         run: bash ../scripts/test_features.sh
+  integration_tests:
+    name: integration tests
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    env:
+      RUSTFLAGS: -D warnings
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Run integration tests
+        run: cargo test -v -p integration_tests --all-features
   check_stable_beta_nightly:
     name: Quick check
     strategy:
@@ -86,6 +99,7 @@ jobs:
     if: success()
     needs:
       - compile_and_test_msrv
+      - integration_tests
       - check_stable_beta_nightly
       - no_std
       - miri

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -24,7 +24,7 @@ jobs:
       - uses: dtolnay/rust-toolchain@nightly
       - uses: taiki-e/install-action@cargo-llvm-cov
       - name: Collect code coverage
-        run: cargo +nightly llvm-cov --all-features -p palette --codecov --doctests --output-path codecov.json
+        run: cargo +nightly llvm-cov --all-features -p integration_tests -p palette --codecov --doctests --output-path codecov.json
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

diff --git a/Cargo.toml b/Cargo.toml
@@ -4,6 +4,7 @@ members = [
     "palette_derive",
 
     # Test crates
+    "integration_tests",
     "no_std_test",
     "benchmarks"
 ]

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ A color management and conversion library that focuses on maintaining correctnes
 
 ## Minimum Supported Rust Version (MSRV)
 
-This version of Palette has been automatically tested with Rust version `1.60.0` and the `stable`, `beta`, and `nightly` channels. Future versions of the library may advance the minimum supported version to make use of new language features, but this will normally be considered a breaking change. Exceptions may be made for security patches and similar changes.
+This version of Palette has been automatically tested with Rust version `1.60.0` and the `stable`, `beta`, and `nightly` channels. Future versions of the library may advance the minimum supported version to make use of new language features, but this will normally be considered a breaking change. Exceptions may be made for security patches, dependencies advancing their MSRV in minor or patch releases, and similar changes.
 
 ## Contributing
 

diff --git a/benchmarks/Cargo.toml b/benchmarks/Cargo.toml
@@ -23,13 +23,17 @@ path = "benches/matrix.rs"
 name = "matrix"
 harness = false
 
+[features]
+# Avoids getting these features included in other packages in the same workspace.
+all_features = ["palette/default", "palette/wide"]
+
 [dev-dependencies]
 approx = { version = "0.5", default-features = false }
 codspeed-criterion-compat = "2.1.0"
 criterion = { version = "0.5.1", default-features = false }
 csv = "1"
 lazy_static = "1"
-palette = { path = "../palette", features = ["wide"] }
+palette = { path = "../palette", default-features = false }
 serde = "1"
 serde_derive = "1"
 wide = "0.7.3"
diff --git a/benchmarks/benches/cie.rs b/benchmarks/benches/cie.rs
@@ -2,7 +2,7 @@ use codspeed_criterion_compat::{black_box, criterion_group, criterion_main, Crit
 use palette::convert::FromColorUnclamped;
 use palette::{Lab, Lch, Xyz, Yxy};
 
-#[path = "../../palette/tests/convert/data_color_mine.rs"]
+#[path = "../../integration_tests/tests/convert/data_color_mine.rs"]
 #[allow(dead_code)]
 mod data_color_mine;
 use data_color_mine::{load_data, ColorMine};

diff --git a/benchmarks/benches/rgb.rs b/benchmarks/benches/rgb.rs
@@ -10,7 +10,7 @@ type LinHsv = Hsv<encoding::Linear<encoding::Srgb>>;
 type LinHsl = Hsl<encoding::Linear<encoding::Srgb>>;
 type LinHwb = Hwb<encoding::Linear<encoding::Srgb>>;
 
-#[path = "../../palette/tests/convert/data_color_mine.rs"]
+#[path = "../../integration_tests/tests/convert/data_color_mine.rs"]
 #[allow(dead_code)]
 mod data_color_mine;
 use data_color_mine::{load_data, ColorMine};

diff --git a/integration_tests/Cargo.toml b/integration_tests/Cargo.toml
@@ -0,0 +1,31 @@
+[package]
+name = "integration_tests"
+version = "0.0.0"
+authors = ["Erik Hedvall <[email protected]>"]
+exclude = []
+description = "Integration test crate for palette."
+repository = "https://github.com/Ogeon/palette"
+license = "MIT OR Apache-2.0"
+edition = "2018"
+
+[[example]]
+name = "issue_283"
+path = "regression_tests/issue_283.rs"
+
+[features]
+# Avoids getting these features included in other packages in the same workspace.
+all_features = ["palette/default", "palette/wide"]
+
+[dev-dependencies]
+approx = { version = "0.5", default-features = false }
+csv = "1"
+lazy_static = "1"
+palette = { path = "../palette" }
+scad = "1.2.2" # For regression testing #283
+serde = "1"
+serde_derive = "1"
+serde_json = "1"
+
+[dev-dependencies.wide]
+version = "0.7.3"
+default-features = false
diff --git a/integration_tests/LICENSE-APACHE b/integration_tests/LICENSE-APACHE
@@ -0,0 +1 @@
+../LICENSE-APACHE
diff --git a/integration_tests/LICENSE-MIT b/integration_tests/LICENSE-MIT
@@ -0,0 +1 @@
+../LICENSE-MIT
diff --git a/palette/regression_tests/issue_283.rs → ...ation_tests/regression_tests/issue_283.rs b/palette/regression_tests/issue_283.rs → ...ation_tests/regression_tests/issue_283.rs
diff --git a/palette/tests/color_checker.rs → integration_tests/tests/color_checker.rs b/palette/tests/color_checker.rs → integration_tests/tests/color_checker.rs
diff --git a/palette/tests/color_checker_data/babel.csv → ..._tests/tests/color_checker_data/babel.csv b/palette/tests/color_checker_data/babel.csv → ..._tests/tests/color_checker_data/babel.csv
diff --git a/palette/tests/color_checker_data/babel.rs → ...n_tests/tests/color_checker_data/babel.rs b/palette/tests/color_checker_data/babel.rs → ...n_tests/tests/color_checker_data/babel.rs
@@ -111,7 +111,6 @@ pub fn run_from_lab_tests() {
     }
 }
 
-#[cfg(feature = "wide")]
 pub mod wide_f64x2 {
     use super::*;
 

diff --git a/...ests/color_checker_data/color_checker.csv → ...ests/color_checker_data/color_checker.csv b/...ests/color_checker_data/color_checker.csv → ...ests/color_checker_data/color_checker.csv
diff --git a/...tests/color_checker_data/color_checker.rs → ...tests/color_checker_data/color_checker.rs b/...tests/color_checker_data/color_checker.rs → ...tests/color_checker_data/color_checker.rs
@@ -111,7 +111,6 @@ pub fn run_from_lab_tests() {
     }
 }
 
-#[cfg(feature = "wide")]
 pub mod wide_f64x2 {
     use super::*;
 

diff --git a/...tte/tests/color_checker_data/load_data.rs → ...sts/tests/color_checker_data/load_data.rs b/...tte/tests/color_checker_data/load_data.rs → ...sts/tests/color_checker_data/load_data.rs
diff --git a/palette/tests/color_checker_data/mod.rs → ...ion_tests/tests/color_checker_data/mod.rs b/palette/tests/color_checker_data/mod.rs → ...ion_tests/tests/color_checker_data/mod.rs
@@ -30,7 +30,6 @@ pub fn color_checker_from_lab() {
     color_checker::run_from_lab_tests();
 }
 
-#[cfg(feature = "wide")]
 pub mod wide {
     #[test]
     pub fn babel_from_yxy() {

diff --git a/palette/tests/color_convert.rs → integration_tests/tests/color_convert.rs b/palette/tests/color_convert.rs → integration_tests/tests/color_convert.rs
diff --git a/palette/tests/convert/data_cie_15_2004.csv → ..._tests/tests/convert/data_cie_15_2004.csv b/palette/tests/convert/data_cie_15_2004.csv → ..._tests/tests/convert/data_cie_15_2004.csv
diff --git a/palette/tests/convert/data_cie_15_2004.rs → ...n_tests/tests/convert/data_cie_15_2004.rs b/palette/tests/convert/data_cie_15_2004.rs → ...n_tests/tests/convert/data_cie_15_2004.rs
@@ -117,7 +117,6 @@ pub fn run_tests() {
     }
 }
 
-#[cfg(feature = "wide")]
 pub mod wide_f32x4 {
     use super::*;
 

diff --git a/palette/tests/convert/data_ciede_2000.csv → ...n_tests/tests/convert/data_ciede_2000.csv b/palette/tests/convert/data_ciede_2000.csv → ...n_tests/tests/convert/data_ciede_2000.csv
diff --git a/palette/tests/convert/data_ciede_2000.rs → ...on_tests/tests/convert/data_ciede_2000.rs b/palette/tests/convert/data_ciede_2000.rs → ...on_tests/tests/convert/data_ciede_2000.rs
diff --git a/palette/tests/convert/data_color_mine.csv → ...n_tests/tests/convert/data_color_mine.csv b/palette/tests/convert/data_color_mine.csv → ...n_tests/tests/convert/data_color_mine.csv
diff --git a/palette/tests/convert/data_color_mine.rs → ...on_tests/tests/convert/data_color_mine.rs b/palette/tests/convert/data_color_mine.rs → ...on_tests/tests/convert/data_color_mine.rs
@@ -416,7 +416,6 @@ pub fn run_from_lch_tests() {
     }
 }
 
-#[cfg(feature = "wide")]
 pub mod wide_f64x2 {
     use super::*;
 

diff --git a/palette/tests/convert/lab_lch.rs → integration_tests/tests/convert/lab_lch.rs b/palette/tests/convert/lab_lch.rs → integration_tests/tests/convert/lab_lch.rs
diff --git a/palette/tests/convert/mod.rs → integration_tests/tests/convert/mod.rs b/palette/tests/convert/mod.rs → integration_tests/tests/convert/mod.rs
@@ -50,7 +50,6 @@ pub fn color_mine_from_hwb() {
     data_color_mine::run_from_hwb_tests();
 }
 
-#[cfg(feature = "wide")]
 pub mod wide {
     #[test]
     pub fn xyz_yxy_conversion() {

diff --git a/palette/tests/hsluv_convert.rs → integration_tests/tests/hsluv_convert.rs b/palette/tests/hsluv_convert.rs → integration_tests/tests/hsluv_convert.rs
diff --git a/...tests/hsluv_dataset/LICENSE.hsluv_dataset → ...tests/hsluv_dataset/LICENSE.hsluv_dataset b/...tests/hsluv_dataset/LICENSE.hsluv_dataset → ...tests/hsluv_dataset/LICENSE.hsluv_dataset
diff --git a/...te/tests/hsluv_dataset/hsluv_dataset.json → ...ts/tests/hsluv_dataset/hsluv_dataset.json b/...te/tests/hsluv_dataset/hsluv_dataset.json → ...ts/tests/hsluv_dataset/hsluv_dataset.json
diff --git a/palette/tests/hsluv_dataset/hsluv_dataset.rs → ...ests/tests/hsluv_dataset/hsluv_dataset.rs b/palette/tests/hsluv_dataset/hsluv_dataset.rs → ...ests/tests/hsluv_dataset/hsluv_dataset.rs
diff --git a/palette/tests/hsluv_dataset/mod.rs → integration_tests/tests/hsluv_dataset/mod.rs b/palette/tests/hsluv_dataset/mod.rs → integration_tests/tests/hsluv_dataset/mod.rs
diff --git a/palette/tests/pointer_convert.rs → integration_tests/tests/pointer_convert.rs b/palette/tests/pointer_convert.rs → integration_tests/tests/pointer_convert.rs
diff --git a/palette/tests/pointer_dataset/mod.rs → ...ration_tests/tests/pointer_dataset/mod.rs b/palette/tests/pointer_dataset/mod.rs → ...ration_tests/tests/pointer_dataset/mod.rs
@@ -9,7 +9,6 @@ pub fn from_lch() {
     pointer_data::run_from_lch_tests();
 }
 
-#[cfg(feature = "wide")]
 mod wide {
     #[test]
     pub fn from_lab() {

diff --git a/...te/tests/pointer_dataset/pointer_data.csv → ...ts/tests/pointer_dataset/pointer_data.csv b/...te/tests/pointer_dataset/pointer_data.csv → ...ts/tests/pointer_dataset/pointer_data.csv
diff --git a/...tte/tests/pointer_dataset/pointer_data.rs → ...sts/tests/pointer_dataset/pointer_data.rs b/...tte/tests/pointer_dataset/pointer_data.rs → ...sts/tests/pointer_dataset/pointer_data.rs
@@ -148,7 +148,6 @@ pub fn run_from_lab_tests() {
     }
 }
 
-#[cfg(feature = "wide")]
 pub mod wide_f64x2 {
     use super::*;
 

diff --git a/palette/Cargo.toml b/palette/Cargo.toml
@@ -40,10 +40,6 @@ std = ["approx?/std"]
 [lib]
 bench = false
 
-[[example]]
-name = "issue_283"
-path = "regression_tests/issue_283.rs"
-
 [dependencies]
 palette_derive = { version = "0.7.3", path = "../palette_derive" }
 fast-srgb8 = "1.0.0"
@@ -76,14 +72,9 @@ optional = true
 default-features = false
 
 [dev-dependencies]
-csv = "1"
-lazy_static = "1"
-serde = "1"
-serde_derive = "1"
 serde_json = "1"
 ron = "=0.8.0" # Pinned due to MSRV mismatch
 enterpolation = "0.2.0"
-scad = "1.2.2" # For regression testing #283
 
 [dev-dependencies.clap]
 version = "3.2.25"

diff --git a/palette/README.md b/palette/README.md
@@ -15,7 +15,7 @@ A color management and conversion library that focuses on maintaining correctnes
 
 ## Minimum Supported Rust Version (MSRV)
 
-This version of Palette has been automatically tested with Rust version `1.60.0` and the `stable`, `beta`, and `nightly` channels. Future versions of the library may advance the minimum supported version to make use of new language features, but this will normally be considered a breaking change. Exceptions may be made for security patches and similar changes.
+This version of Palette has been automatically tested with Rust version `1.60.0` and the `stable`, `beta`, and `nightly` channels. Future versions of the library may advance the minimum supported version to make use of new language features, but this will normally be considered a breaking change. Exceptions may be made for security patches, dependencies advancing their MSRV in minor or patch releases, and similar changes.
 
 ## Getting Started
 

diff --git a/palette_derive/README.md b/palette_derive/README.md
@@ -4,7 +4,7 @@ Contains derive macros for the [`palette`](https://crates.io/crates/palette/) cr
 
 ## Minimum Supported Rust Version (MSRV)
 
-This version of Palette has been automatically tested with Rust version `1.60.0` and the `stable`, `beta`, and `nightly` channels. Future versions of the library may advance the minimum supported version to make use of new language features, but this will normally be considered a breaking change. Exceptions may be made for security patches and similar changes.
+This version of Palette has been automatically tested with Rust version `1.60.0` and the `stable`, `beta`, and `nightly` channels. Future versions of the library may advance the minimum supported version to make use of new language features, but this will normally be considered a breaking change. Exceptions may be made for security patches, dependencies advancing their MSRV in minor or patch releases, and similar changes.
 
 ## License