feat(ci): Update CI to allow the chain-sync-v2 catalyst gateway branc…

…h to build cleanly. (#306)

* ci(rust): Cat-Gateway has an unavoidable dependency on open-ssl.  Allow for now.

* feat(rust): Add a function to make syncing std rust config locally easier.

* feat(cspell): Use latest cspell tool, and add a function to clean project words file.

* fix(cspell): Missing FUNCTION keyword

* fix(docs): spelling

* feat(cspell): Add target to clean the spelling list

* fix(docs): Cleaned spelling list

* feat(mdlint): Bump mdlint version to latest

* fix(rust): sync deny.toml across utilities and examples

* feat(cat-ci): Add Justfile in root to make running some tasks easier.

* fix(rust): Missing FUNCTIOn keyword in sync-std-cfg function

* fix(rust): Fix reference to the rust installer package

* fix(cspell): Remove duplicate lines from the project dictionary

* fix(docs): cleanup duplicates from project dictionary

* fix(postgresql): Replace ancient "stable" sqlfluff debian distributes, with latest one.

* fix(mithril): Remove mithril snapshots from CI.

* style(postgresql): Adjust the sql code format to match requirements.

.config/dictionaries/project.dic

@@ -1,7 +1,7 @@
 aarch
 bindgen
-buildkit
 binstall
+buildkit
 camelcase
 canvaskit
 cardano
@@ -17,7 +17,6 @@ dockerhub
 doublecircle
 Earthfile
 Earthfiles
-edgedriver
 Edgedriver
 errchkjson
 extldflags
@@ -29,7 +28,6 @@ fontawesome
 fontconfig
 fontname
 forcelabels
-geckodriver
 Geckodriver
 genpkey
 giga
@@ -39,7 +37,6 @@ glightbox
 GOCACHE
 gofmt
 goimports
-golangci
 GOLANGCI
 golines
 golint
@@ -114,4 +111,4 @@ webkitallowfullscreen
 WORKDIR
 xerrors
 zstd
-zstdcat
+zstdcat

.markdownlint.jsonc

@@ -1,7 +1,7 @@
 {
  // markdownlint JSON(C) configuration for Catalyst Standards
  // Do not individually set markdown lint rules in documents.
- // It is permissable to disable a rule in a document if it is a false positive.
+ // It is permissible to disable a rule in a document if it is a false positive.
  // Keep the scope of the lint disable to as small as possible.
  // See: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
  // Default state for all rules

Earthfile

@@ -18,6 +18,11 @@ markdown-check-fix:
 
  DO mdlint-ci+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix
 
+# Make sure the project dictionary is properly sorted.
+clean-spelling-list:
+ FROM debian:stable-slim
+ DO cspell-ci+CLEAN
+
 # check-spelling Check spelling in this repo inside a container.
 check-spelling:
  DO cspell-ci+CHECK

Justfile

@@ -0,0 +1,20 @@
+# use with https://github.com/casey/just
+#
+
+# cspell: words prereqs, commitlog
+
+default:
+ @just --list --unsorted
+
+
+# Fix and Check Markdown files
+check-markdown:
+ earthly +markdown-check-fix
+
+# Check Spelling
+check-spelling:
+ earthly +clean-spelling-list
+ earthly +check-spelling
+
+# Pre Push Checks - intended to be run by a git pre-push hook.
+pre-push: check-markdown check-spelling

earthly/cspell/Earthfile

@@ -1,5 +1,6 @@
 VERSION 0.8
 
+# CHECK: Check spelling in all files that are not explicitly excluded.
 CHECK:
  # Spell checking all docs and code is done with cspell
  # See: cspell.org
@@ -11,9 +12,19 @@ CHECK:
  # Unlikely to need to change this.
  ARG cfg_file=cspell.json
 
- FROM ghcr.io/streetsidesoftware/cspell:8.0.0
+ FROM ghcr.io/streetsidesoftware/cspell:8.13.3
  WORKDIR /work
 
  COPY $src .
 
- RUN cspell-cli lint . --dot
+ RUN cspell-cli lint . --dot
+
+# CLEAN: Cleanup the project dictionary.
+CLEAN:
+ FUNCTION
+
+ COPY .config/dictionaries/project.dic project.dic
+ RUN sort -u -d -f project.dic > new.dic
+ IF ! diff -q project.dic new.dic
+ SAVE ARTIFACT new.dic AS LOCAL .config/dictionaries/project.dic
+ END

earthly/mdlint/Earthfile

@@ -35,7 +35,7 @@ MDLINT_LOCALLY:
  RUN docker run \
  --rm \
  -v $src:/workdir \
- davidanson/markdownlint-cli2-rules:v0.11.0 \
+ davidanson/markdownlint-cli2-rules:v0.14.0 \
  "**/*.md" \
  --config $cfg_file \
  $fix
@@ -61,7 +61,7 @@ CHECK:
  # Unlikely this ever needs to be changed.
  ARG cfg_file=.markdownlint-cli2.jsonc
 
- FROM davidanson/markdownlint-cli2-rules:v0.11.0 
+ FROM davidanson/markdownlint-cli2-rules:v0.14.0 
 
  # Status line for what we are about to do.
  RUN echo Linting Markdown Recursively from: $src

earthly/postgresql/Earthfile

@@ -33,11 +33,12 @@ postgres-base:
  python3-psycopg \
  ripgrep \
  wget \
- sqlfluff \
+ pipx \
  && rm -rf /var/lib/apt/lists/*
 
  # Install SQLFluff - Check
- RUN sqlfluff version
+ ENV PATH="/root/.local/bin:${PATH}"
+ RUN pipx install sqlfluff==3.1.1 && sqlfluff version
 
  # Get refinery
  COPY rust-tools+tool-refinery/refinery /bin

earthly/rust/Earthfile

@@ -291,3 +291,16 @@ SETUP:
  # The ONLY toolchain we support is the one in the installer.
  # DO NOT copy the `rust-toolchain.toml` file into CI as it breaks
  # the toolchain on some targets and leads to build failure.
+
+
+# SYNC_STD_CFG : Syncs the standard config files locally.
+SYNC_STD_CFG:
+ FUNCTION
+ FROM +installer
+
+ SAVE ARTIFACT /stdcfgs/cargo_config.toml AS LOCAL .cargo/config.toml
+ SAVE ARTIFACT /stdcfgs/clippy.toml AS LOCAL clippy.toml
+ SAVE ARTIFACT /stdcfgs/nextest.toml AS LOCAL .config/nextest.toml
+ SAVE ARTIFACT /stdcfgs/deny.toml AS LOCAL deny.toml
+ SAVE ARTIFACT /stdcfgs/rustfmt.toml AS LOCAL rustfmt.toml
+ SAVE ARTIFACT /stdcfgs/rust-toolchain.toml AS LOCAL rust-toolchain.toml

earthly/rust/stdcfgs/deny.toml

@@ -26,10 +26,13 @@ ignore = [
 multiple-versions = "warn"
 wildcards = 'deny'
 deny = [
- # { crate = "git2", use-instead = "gix" },
- { crate = "openssl", use-instead = "rustls" },
- { crate = "openssl-sys", use-instead = "rustls" },
+ # Scylla DB Drivers currently require OpenSSL. Its unavoidable.
+ # However, there is movement to enable support for Rustls. 
+ # So, for now, allow open-ssl but it needs to be disabled as soon as Scylla DB enables Rustls.
+ #{ crate = "openssl", use-instead = "rustls" },
+ #{ crate = "openssl-sys", use-instead = "rustls" },
  "libssh2-sys",
+ # { crate = "git2", use-instead = "gix" },
  # { crate = "cmake", use-instead = "cc" },
  # { crate = "windows", reason = "bloated and unnecessary", use-instead = "ideally inline bindings, practically, windows-sys" },
 ]

examples/postgresql/migrations/V1__users.sql

@@ -1,5 +1,5 @@
 CREATE TABLE users
 (
-  name VARCHAR PRIMARY KEY,
-  age INTEGER NOT NULL
+ name VARCHAR PRIMARY KEY,
+ age INTEGER NOT NULL
 );

examples/postgresql/migrations/V2__addresses.sql

@@ -1,7 +1,7 @@
 CREATE TABLE address
 (
-  name VARCHAR PRIMARY KEY,
-  address TEXT NOT NULL,
+ name VARCHAR PRIMARY KEY,
+ address TEXT NOT NULL,
 
-  FOREIGN KEY (name) REFERENCES users (name)
+ FOREIGN KEY (name) REFERENCES users (name)
 );

examples/rust/deny.toml

@@ -26,10 +26,13 @@ ignore = [
 multiple-versions = "warn"
 wildcards = 'deny'
 deny = [
- # { crate = "git2", use-instead = "gix" },
- { crate = "openssl", use-instead = "rustls" },
- { crate = "openssl-sys", use-instead = "rustls" },
+ # Scylla DB Drivers currently require OpenSSL. Its unavoidable.
+ # However, there is movement to enable support for Rustls. 
+ # So, for now, allow open-ssl but it needs to be disabled as soon as Scylla DB enables Rustls.
+ #{ crate = "openssl", use-instead = "rustls" },
+ #{ crate = "openssl-sys", use-instead = "rustls" },
  "libssh2-sys",
+ # { crate = "git2", use-instead = "gix" },
  # { crate = "cmake", use-instead = "cc" },
  # { crate = "windows", reason = "bloated and unnecessary", use-instead = "ideally inline bindings, practically, windows-sys" },
 ]

utilities/dbviz/deny.toml

@@ -26,10 +26,13 @@ ignore = [
 multiple-versions = "warn"
 wildcards = 'deny'
 deny = [
- # { crate = "git2", use-instead = "gix" },
- { crate = "openssl", use-instead = "rustls" },
- { crate = "openssl-sys", use-instead = "rustls" },
+ # Scylla DB Drivers currently require OpenSSL. Its unavoidable.
+ # However, there is movement to enable support for Rustls. 
+ # So, for now, allow open-ssl but it needs to be disabled as soon as Scylla DB enables Rustls.
+ #{ crate = "openssl", use-instead = "rustls" },
+ #{ crate = "openssl-sys", use-instead = "rustls" },
  "libssh2-sys",
+ # { crate = "git2", use-instead = "gix" },
  # { crate = "cmake", use-instead = "cc" },
  # { crate = "windows", reason = "bloated and unnecessary", use-instead = "ideally inline bindings, practically, windows-sys" },
 ]