feat: proof of concept

.cargo/config.toml

@@ -0,0 +1,6 @@
+[target.x86_64-pc-windows-msvc]
+rustflags = [
+  # Link the static version of the C runtime - this seems to be a common setup for Rust CLIs.
+  # Zinnia binaries use the static runtime and we want to support Zinnia.
+  "-C", "target-feature=+crt-static",
+]

.devcontainer/devcontainer.json

@@ -0,0 +1,44 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/rust
+{
+	"name": "Rust-Go",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/rust:1",
+	"features": {
+		"ghcr.io/devcontainers/features/go:1": {
+			"version": "latest"
+		}
+	},
+
+	// Use 'mounts' to make the cargo cache persistent in a Docker Volume.
+	"mounts": [
+		{
+			"source": "devcontainer-cargo-cache-${devcontainerId}",
+			"target": "/usr/local/cargo",
+			"type": "volume"
+		}
+	],
+
+	"runArgs": [
+		// It seems that Docker and/or DevContainers allow apps to listen on any port.
+		// Our test suite relies on port 1 being privileged (not allowed to listen on other users than root)
+		// and therefore fails with in the default DevContainer setup.
+		// Here we fix the problem by configuring ports 0-1023 as being privileged.
+		"--sysctl", "net.ipv4.ip_unprivileged_port_start=1024"
+	],
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "rustc --version && go version"
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/workflows/cargo-audit.yml

@@ -0,0 +1,13 @@
+name: Security audit
+on:
+  push:
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+jobs:
+  security_audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: cargo install cargo-audit
+      - run: cargo audit

.github/workflows/ci.yaml

@@ -0,0 +1,124 @@
+name: Continuous integration
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  SEGMENT_DOWNLOAD_TIMEOUT_MINS: 2 # Fail cache download after 2 minutes.
+
+jobs:
+  build-test:
+    name: ${{ matrix.target }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - target: x86_64-apple-darwin
+            os: macos-latest
+          - target: x86_64-pc-windows-msvc
+            os: windows-latest
+          - target: x86_64-unknown-linux-gnu
+            os: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@52e69531e6f69a396bc9d1226284493a5db969ff # v1
+        with:
+          toolchain: stable
+          target: ${{ matrix.target }}
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 'stable'
+
+      - uses: Swatinem/rust-cache@988c164c3d0e93c4dbab36aaf5bbeb77425b2894 # v2.4.0
+        with:
+          shared-key: ${{ matrix.target }}
+          # Always save the build artifacts to the cache to speed up builds of additional
+          # commits added to an already-opened pull request.
+          # save-if: ${{ github.ref == 'refs/heads/main' }}
+
+
+      - name: Build the library
+        run: cargo build --lib --all-features --target=${{ matrix.target }}
+
+      - name: Run all tests
+        run: cargo test --all-features --target=${{ matrix.target }}
+
+  lint:
+    name: Run Rust linters
+    runs-on: ubuntu-latest
+    needs: build-test
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: dtolnay/rust-toolchain@52e69531e6f69a396bc9d1226284493a5db969ff # v1
+        with:
+          toolchain: stable
+          components: clippy,rustfmt
+
+      - uses: Swatinem/rust-cache@988c164c3d0e93c4dbab36aaf5bbeb77425b2894 # v2.4.0
+        with:
+          shared-key: "x86_64-unknown-linux-gnu"
+          save-if: false
+
+      - name: Check Rust formatting
+        run: cargo fmt -- --check
+
+      - name: Run cargo clippy
+        run: cargo clippy # cargo alias to allow reuse of config locally
+
+      - name: Check rustdoc links
+        run: RUSTDOCFLAGS="--deny rustdoc::broken_intra_doc_links --deny warnings" cargo doc --verbose --workspace --no-deps --all-features --document-private-items
+
+  prettier-check:
+    name: Check Markdown formatting (Prettier)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actionsx/prettier@e90ec5455552f0f640781bdd5f5d2415acb52f1a # latest
+        with:
+          # prettier CLI arguments.
+          args: --check .
+
+  validate_pr_title:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
+    steps:
+      - uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Configure which types are allowed (newline delimited).
+          types: |
+            feat
+            fix
+            chore
+            docs
+            deps
+            test
+            ci
+            refactor
+          requireScope: false
+
+      - name: Check PR title length
+        env:
+          TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          title_length=${#TITLE}
+          if [ $title_length -gt 72 ]
+          then
+            echo "PR title is too long (greater than 72 characters)"
+            exit 1
+          fi

.gitignore

@@ -5,8 +5,7 @@
 
 # Generated by Cargo
 # will have compiled files and executables
-debug/
-target/
+/target
 
 # These are backup files generated by rustfmt
 **/*.rs.bk
@@ -44,3 +43,5 @@ go.work
 ########
 # Project-specific
 ########
+
+go-lib/_obj

.prettierignore

@@ -0,0 +1,7 @@
+# The goal of the configuration below is to configure Prettier to lint Markdown and JavaScript files.
+**/*.*
+!**/*.md
+!**/*.js
+
+# Let's keep LICENSE.md in the same formatting as we use in other PL repositories
+LICENSE.md

.prettierrc.yaml

@@ -0,0 +1,2 @@
+proseWrap: always
+trailingComma: all