test

Author: syphar

.github/workflows/ci.yml

@@ -17,13 +17,6 @@ jobs:
     steps:
       - uses: actions/checkout@v5
 
-      # We check that all github actions workflows have valid syntax
-      - name: Validate YAML file
-        uses: raven-actions/actionlint@v2
-        with:
-          files: .github/workflow/*
-          flags: "-ignore SC2086"  # ignore some shellcheck errors
-
       - name: install `just`
         run: sudo snap install --edge --classic just
 
@@ -37,24 +30,14 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Launch postgres
-        run: just _ensure_db_and_s3_are_running
-
       - name: install SQLX CLI
         run: cargo binstall sqlx-cli
 
-      - name: run database migrations
-        run: cargo sqlx migrate run --database-url $DOCSRS_DATABASE_URL
-
-      - name: run sqlx prepare --check
-        run: just sqlx-prepare
-
-      - name: test reverse migrations
+      - name: run sqlx migration up & down
         run: |
-          # --target 0 means "revert everything"
-          cargo sqlx migrate revert \
-            --database-url $DOCSRS_DATABASE_URL \
-            --target-version 0
+          just sqlx-migrate-run \
+            sqlx-check \
+            sqlx-migrate-revert
 
       - name: shut down test environment
         if: ${{ always() }}
@@ -122,6 +105,7 @@ jobs:
       - run: just lint
 
   lint-js:
+    name: js linters
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -132,3 +116,16 @@ jobs:
         run: sudo snap install --edge --classic just
 
       - run: just lint-js
+
+  lint-actions:
+    name: gh actions linters
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      # We check that all github actions workflows have valid syntax
+      - name: Validate YAML file
+        uses: raven-actions/actionlint@v2
+        with:
+          files: .github/workflow/*
+          flags: "-ignore SC2086"  # ignore some shellcheck errors

justfiles/testing.just

@@ -1,17 +1,48 @@
 # just commands for CI & local development
+set dotenv-load := true
+set dotenv-override := true
 
+# some environment variables that are needed for _local_ commands
+# these are defaults that can be overwritten in your local .env file
+export DOCSRS_INCLUDE_DEFAULT_TARGETS := env("DOCSRS_INCLUDE_DEFAULT_TARGETS", "false")
+export DOCSRS_LOG := env("DOCSRS_LOG", "docs_rs=debug,rustwide=info")
+export RUST_BACKTRACE := env("RUST_BACKTRACE", "1")
+export DOCSRS_PREFIX := env("DOCSRS_PREFIX", "ignored/cratesfyi-prefix")
+
+# database & s3 settings for local testing, to connect to the DB & S3/minio instance 
+# configured in docker-compose.yml
+export DOCSRS_DATABASE_URL := env("DOCSRS_DATABASE_URL", "postgresql://cratesfyi:password@localhost:15432")
+export AWS_ACCESS_KEY_ID := env("AWS_ACCESS_KEY_ID", "cratesfyi")
+export AWS_SECRET_ACCESS_KEY := env("AWS_SECRET_ACCESS_KEY", "secret_key")
+export S3_ENDPOINT := env("S3_ENDPOINT", "http://localhost:9000")
 
 
 [group('testing')]
-sqlx-prepare *args:
+[group('sqlx')]
+sqlx-prepare *args: _ensure_db_and_s3_are_running
   cargo sqlx prepare \
     --database-url $DOCSRS_DATABASE_URL \
     --workspace {{ args }} \
     -- --all-targets --all-features
 
 [group('testing')]
+[group('sqlx')]
 sqlx-check:
-  just sqlx-prepare -check
+  just sqlx-prepare --check
+
+[group('testing')]
+[group('sqlx')]
+sqlx-migrate-run: _ensure_db_and_s3_are_running
+  cargo sqlx migrate run --database-url $DOCSRS_DATABASE_URL
+
+[group('testing')]
+[group('sqlx')]
+sqlx-migrate-revert target="0": _ensure_db_and_s3_are_running
+  # --target 0 means "revert everything"
+  cargo sqlx migrate revert \
+    --database-url $DOCSRS_DATABASE_URL \
+    --target-version {{ target }}
+
 
 # Format the code using `cargo fmt`. 
 [group('testing')]