Implement validation module

.ci/test-cover

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+set -e
+
+DESTDIR="${PWD}/target/cover"
+
+rustup component add llvm-tools
+cargo install grcov
+
+export RUSTFLAGS="-Cinstrument-coverage"
+export LLVM_PROFILE_FILE="${DESTDIR}/default_%m_%p.profraw"
+cargo test
+
+grcov "${DESTDIR}" \
+    --ignore '**/clang-sys*/**' \
+    --ignore "$HOME/.cargo/**" \
+    --ignore-not-existing \
+    --ignore 'tests/**' \
+    --excl-start '#(\[cfg\(test\)\]|\[test\])' \
+    --llvm \
+    --binary-path "target/debug/" \
+    -s . \
+    --branch \
+    -o "${DESTDIR}" \
+    --output-types html,cobertura
+
+xmllint --xpath "concat('Coverage: ', 100 * string(//coverage/@line-rate), '%')" "${DESTDIR}/cobertura.xml"
+
+if [ "$(uname -o)" = "Darwin" ] && [ -z "$CI" ]; then
+	open "${DESTDIR}/html/index.html"
+fi

.github/workflows/test-and-lint.yml

@@ -33,3 +33,13 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
       - name: Run pre-commit
         uses: pre-commit/[email protected]
+      - name: Install dependencies
+        run: sudo apt-get install -y libxml2-utils
+      - name: Generate Coverage
+        run: make cover RUST_BACKTRACE=1
+      - name: Publish Coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: pgxn/meta
+          files: target/cover/cobertura.xml

.pre-commit-config.yaml

@@ -13,6 +13,14 @@ repos:
         name: Don't permit large files
         exclude_types: [image]
 
+  - repo: local
+    hooks:
+      - id: cargo-doc
+        name: cargo doc
+        entry: cargo doc
+        language: system
+        pass_filenames: false
+
   - repo: https://github.com/backplane/pre-commit-rust-hooks
     rev: v1.1.0
     hooks:

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "pgxn-meta-spec"
+name = "pgxn_meta"
 version = "0.1.0"
 description = "The PGXN distribution metadata specification"
 repository = "https://github.com/pgxn/pgxn-meta-spec"
@@ -12,10 +12,12 @@ exclude = [ ".github", ".gitattributes", "target", ".vscode", ".gitignore" ]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
-[dev-dependencies]
-boon = "0.6"
-serde_json = "1.0"
-
 [dependencies]
+boon = "0.6"
+relative-path = "1.9.3"
 serde = { version = "1", features = ["derive"] }
+serde_json = "1.0"
 spdx = "0.10.6"
+wax = "0.6.0"
+
+[dev-dependencies]

Makefile

@@ -1,4 +1,4 @@
-.PHONY: test # Validate the JSON schema.
+.PHONY: test # Run the full test suite.
 test:
 	@cargo test
 
@@ -9,3 +9,14 @@ test:
 .PHONY: lint # Lint the project
 lint: .pre-commit-config.yaml
 	@pre-commit run --show-diff-on-failure --color=always --all-files
+
+.PHONY: cover # Run cover tests and generate & open a report.
+cover:
+	@./.ci/test-cover
+
+.PHONY: docs # Generate and open cargo docs.
+docs: target/doc/pgxn_meta/index.html
+	open $<
+
+target/doc/pgxn_meta/index.html: $(shell find . -name \*.rs)
+	cargo doc