Merge pull request #27 from codecov/pr27

move to cargo workspace + small readme edits
codecov · Aug 28, 2024 · bd6fe6c · bd6fe6c
2 parents 87b8459 + 595a8df
commit bd6fe6c
Show file tree

Hide file tree

Showing 40 changed files with 39 additions and 30 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,30 +1,8 @@
-[package]
-name = "codecov-rs"
-version = "0.1.0"
-edition = "2021"
+[workspace]
 
-[features]
-default = ["pyreport"]
-pyreport = []
+resolver = "2"
+members = ["core"]
 
 [profile.release]
-debug = 1
-
-[dependencies]
-include_dir = "0.7.3"
-memmap2 = "0.9.4"
-rand = "0.8.5"
-rusqlite = { version = "0.31.0", features = ["bundled", "limits"] }
-rusqlite_migration = { version = "1.2.0", features = ["from-directory"] }
-seahash = "4.1.0"
-serde_json = "1.0.117"
-thiserror = "1.0.59"
-winnow = "0.5.34"
 
-[dev-dependencies]
-divan = "0.1.14"
-tempfile = "3.9.0"
-
-[[bench]]
-name = "pyreport"
-harness = false
+debug = 1
diff --git a/README.md b/README.md
@@ -16,22 +16,26 @@ All details (e.g. SQLite schema, code interfaces) subject to breaking changes un
 
 ## Developing
 
-At time of writing, `codecov-rs` requires the nightly compiler for niceties such as `#[feature(trait_alias)]` in the library itself and some convenient `mockall` behavior in tests.
+At time of writing, `codecov-rs` requires the nightly compiler for niceties such as `#[feature(trait_alias)]` in the library itself.
 
 `codecov-rs` aims to serve as effective documentation for every flavor of every format it supports. To that end, the following are greatly appreciated in submissions:
 - Thorough doc comments (`///` / `/**`). For parsers, include snippets that show what inputs look like
-- Granular, in-module unit tests (`mockall` may help)
+- Granular, in-module unit tests
 - Integration tests with real-world samples (that are safe to distribute; don't send us data from your private repo)
 
+Large sample test reports are checked in using [Git LFS](https://git-lfs.com/) in `core/fixtures/**/large` directories (e.g. `core/fixtures/pyreport/large`). Tests and benchmarks may reference them so installing it yourself is recommended.
+
 The `examples/` directory contains runnable commands for developers including:
 - `parse_pyreport`: converts a given pyreport into a SQLite report
 - `sql_to_pyreport`: converts a given SQLite report into a pyreport (report JSON + chunks file)
 
-Considering following suit for your own new feature.
+You can run an example with `cargo run --example <example> <arguments>`. Consider following suit for your own new feature.
 
 Install lint hooks with `pip install pre-commit && pre-commit install`.
 
-Large sample test reports are checked in using [Git LFS](https://git-lfs.com/). Tests and benchmarks may reference them so installing it yourself is recommended.
+### Repository structure
+
+- `core/`: Rust crate with all of the core coverage-processing functionality
 
 ### Writing new parsers
 

diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -0,0 +1,27 @@
+[package]
+name = "codecov-rs"
+version = "0.1.0"
+edition = "2021"
+
+[features]
+default = ["pyreport"]
+pyreport = []
+
+[dependencies]
+include_dir = "0.7.3"
+memmap2 = "0.9.4"
+rand = "0.8.5"
+rusqlite = { version = "0.31.0", features = ["bundled", "limits"] }
+rusqlite_migration = { version = "1.2.0", features = ["from-directory"] }
+seahash = "4.1.0"
+serde_json = "1.0.117"
+thiserror = "1.0.59"
+winnow = "0.5.34"
+
+[dev-dependencies]
+divan = "0.1.14"
+tempfile = "3.9.0"
+
+[[bench]]
+name = "pyreport"
+harness = false
diff --git a/benches/pyreport.rs → core/benches/pyreport.rs b/benches/pyreport.rs → core/benches/pyreport.rs
diff --git a/examples/parse_pyreport.rs → core/examples/parse_pyreport.rs b/examples/parse_pyreport.rs → core/examples/parse_pyreport.rs
diff --git a/examples/sql_to_pyreport.rs → core/examples/sql_to_pyreport.rs b/examples/sql_to_pyreport.rs → core/examples/sql_to_pyreport.rs
diff --git a/...1753c7a540e5248c2beaa079fc3341-chunks.txt → ...1753c7a540e5248c2beaa079fc3341-chunks.txt b/...1753c7a540e5248c2beaa079fc3341-chunks.txt → ...1753c7a540e5248c2beaa079fc3341-chunks.txt
diff --git a/...a540e5248c2beaa079fc3341-report_json.json → ...a540e5248c2beaa079fc3341-report_json.json b/...a540e5248c2beaa079fc3341-report_json.json → ...a540e5248c2beaa079fc3341-report_json.json
diff --git a/migrations/01-init/down.sql → core/migrations/01-init/down.sql b/migrations/01-init/down.sql → core/migrations/01-init/down.sql
diff --git a/migrations/01-init/up.sql → core/migrations/01-init/up.sql b/migrations/01-init/up.sql → core/migrations/01-init/up.sql
diff --git a/src/error.rs → core/src/error.rs b/src/error.rs → core/src/error.rs
diff --git a/src/lib.rs → core/src/lib.rs b/src/lib.rs → core/src/lib.rs
diff --git a/src/parsers/common.rs → core/src/parsers/common.rs b/src/parsers/common.rs → core/src/parsers/common.rs
diff --git a/src/parsers/json.rs → core/src/parsers/json.rs b/src/parsers/json.rs → core/src/parsers/json.rs
diff --git a/src/parsers/mod.rs → core/src/parsers/mod.rs b/src/parsers/mod.rs → core/src/parsers/mod.rs
diff --git a/src/parsers/pyreport/chunks.rs → core/src/parsers/pyreport/chunks.rs b/src/parsers/pyreport/chunks.rs → core/src/parsers/pyreport/chunks.rs
diff --git a/src/parsers/pyreport/mod.rs → core/src/parsers/pyreport/mod.rs b/src/parsers/pyreport/mod.rs → core/src/parsers/pyreport/mod.rs
diff --git a/src/parsers/pyreport/report_json.rs → core/src/parsers/pyreport/report_json.rs b/src/parsers/pyreport/report_json.rs → core/src/parsers/pyreport/report_json.rs
diff --git a/src/parsers/pyreport/utils.rs → core/src/parsers/pyreport/utils.rs b/src/parsers/pyreport/utils.rs → core/src/parsers/pyreport/utils.rs
diff --git a/src/report/mod.rs → core/src/report/mod.rs b/src/report/mod.rs → core/src/report/mod.rs
diff --git a/src/report/models.rs → core/src/report/models.rs b/src/report/models.rs → core/src/report/models.rs
diff --git a/src/report/pyreport/chunks.rs → core/src/report/pyreport/chunks.rs b/src/report/pyreport/chunks.rs → core/src/report/pyreport/chunks.rs
diff --git a/src/report/pyreport/mod.rs → core/src/report/pyreport/mod.rs b/src/report/pyreport/mod.rs → core/src/report/pyreport/mod.rs
diff --git a/...t/pyreport/queries/chunks_file_header.sql → ...t/pyreport/queries/chunks_file_header.sql b/...t/pyreport/queries/chunks_file_header.sql → ...t/pyreport/queries/chunks_file_header.sql
diff --git a/...pyreport/queries/files_to_report_json.sql → ...pyreport/queries/files_to_report_json.sql b/...pyreport/queries/files_to_report_json.sql → ...pyreport/queries/files_to_report_json.sql
diff --git a/...rt/pyreport/queries/samples_to_chunks.sql → ...rt/pyreport/queries/samples_to_chunks.sql b/...rt/pyreport/queries/samples_to_chunks.sql → ...rt/pyreport/queries/samples_to_chunks.sql
diff --git a/...eport/queries/sessions_to_report_json.sql → ...eport/queries/sessions_to_report_json.sql b/...eport/queries/sessions_to_report_json.sql → ...eport/queries/sessions_to_report_json.sql
diff --git a/src/report/pyreport/report_json.rs → core/src/report/pyreport/report_json.rs b/src/report/pyreport/report_json.rs → core/src/report/pyreport/report_json.rs
diff --git a/src/report/pyreport/types.rs → core/src/report/pyreport/types.rs b/src/report/pyreport/types.rs → core/src/report/pyreport/types.rs
diff --git a/src/report/sqlite/mod.rs → core/src/report/sqlite/mod.rs b/src/report/sqlite/mod.rs → core/src/report/sqlite/mod.rs
diff --git a/src/report/sqlite/models.rs → core/src/report/sqlite/models.rs b/src/report/sqlite/models.rs → core/src/report/sqlite/models.rs
diff --git a/src/report/sqlite/queries/totals.sql → core/src/report/sqlite/queries/totals.sql b/src/report/sqlite/queries/totals.sql → core/src/report/sqlite/queries/totals.sql
diff --git a/src/report/sqlite/report.rs → core/src/report/sqlite/report.rs b/src/report/sqlite/report.rs → core/src/report/sqlite/report.rs
diff --git a/src/report/sqlite/report_builder.rs → core/src/report/sqlite/report_builder.rs b/src/report/sqlite/report_builder.rs → core/src/report/sqlite/report_builder.rs
diff --git a/src/report/test.rs → core/src/report/test.rs b/src/report/test.rs → core/src/report/test.rs
diff --git a/tests/common/mod.rs → core/tests/common/mod.rs b/tests/common/mod.rs → core/tests/common/mod.rs
diff --git a/...sample_data/codecov-rs-chunks-d2a9ba1.txt → ...sample_data/codecov-rs-chunks-d2a9ba1.txt b/...sample_data/codecov-rs-chunks-d2a9ba1.txt → ...sample_data/codecov-rs-chunks-d2a9ba1.txt
diff --git a/..._data/codecov-rs-reports-json-d2a9ba1.txt → ..._data/codecov-rs-reports-json-d2a9ba1.txt b/..._data/codecov-rs-reports-json-d2a9ba1.txt → ..._data/codecov-rs-reports-json-d2a9ba1.txt
diff --git a/tests/test_pyreport_shim.rs → core/tests/test_pyreport_shim.rs b/tests/test_pyreport_shim.rs → core/tests/test_pyreport_shim.rs
diff --git a/tests/test_sqlite_report.rs → core/tests/test_sqlite_report.rs b/tests/test_sqlite_report.rs → core/tests/test_sqlite_report.rs