style and lint fixes, add test/lint CI

Author: jhheider

.github/workflows/check-and-lint.yaml

@@ -0,0 +1,67 @@
+# https://github.com/BamPeers/rust-ci-github-actions-workflow
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+name: Check and Lint
+
+jobs:
+  check:
+    name: Check
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+      - uses: actions-rs/cargo@v1
+        with:
+          command: check
+        env:
+          RUSTFLAGS: "-D warnings"
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+      - run: rustup component add rustfmt
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          components: clippy
+          override: true
+      - uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --all-features
+        env:
+          RUSTFLAGS: "-D warnings"
+
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: nosborn/github-action-markdown-cli@v3.2.0
+        with:
+          files: .

.github/workflows/test.yml

@@ -0,0 +1,60 @@
+# https://github.com/BamPeers/rust-ci-github-actions-workflow
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+name: Test # with Code Coverage
+
+jobs:
+  test:
+    name: Test
+    env:
+      PROJECT_NAME_UNDERSCORE: bpb_pkgx
+      CARGO_INCREMENTAL: 0
+      RUSTFLAGS: -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=abort -D warnings
+      RUSTDOCFLAGS: -Cpanic=abort
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-dependencies
+        with:
+          path: |
+            ~/.cargo/.crates.toml
+            ~/.cargo/.crates2.json
+            ~/.cargo/bin
+            ~/.cargo/registry/index
+            ~/.cargo/registry/cache
+            target
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }}
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --all-features
+
+  # coverage:
+  #   name: Coverage
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: actions-rs/toolchain@v1
+  #       with:
+  #         profile: minimal
+  #         toolchain: nightly
+  #         override: true
+  #     - name: Generate test result and coverage report
+  #       run: |
+  #         cargo install cargo-tarpaulin
+  #         cargo tarpaulin --engine ptrace -o lcov --output-dir coverage --coveralls $COVERALLS_TOKEN
+  #       env:
+  #         COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}

Cargo.lock

@@ -11,8 +11,8 @@ authors = ["Without Boats <boats@mozilla.com>", "Jacob Heider <jacob@pkgx.dev>"]
 toml = "0.4.6"
 rand = { version = "0.8.5", features = ["std"] }
 sha2 = "0.7.1"
-serde_derive = "1.0.70"
-serde = "1.0.70"
+serde_derive = "1.0.215"
+serde = "1.0.215"
 hex = "0.3.2"
 failure = "0.1.1"
 

Cargo.toml

@@ -6,10 +6,15 @@ do.
 
 ## `pkgx` Updates
 
-* Updated to edition 2021 by pkgx
-* Stores the private key in the macOS keychain such that only this tool (when
+- Updated to edition 2021 by pkgx
+- Stores the private key in the macOS keychain such that only this tool (when
   codesigned) can access it.
 
+### TODO
+
+- [ ] Move keychain identifiers out to build variables in `config.rs`
+- [ ] Move keychain identifier out to a build variable in `keychain.rs`
+
 ## How to Install
 
 ```sh

README.md

@@ -1,11 +1,13 @@
-use std::io::{Read, Write};
+use std::io::Read;
 
 use failure::Error;
 
 use crate::key_data::KeyData;
 
-use crate::keychain::get_keychain_item;
-use crate::keychain::add_keychain_item;
+use crate::keychain::{add_keychain_item, get_keychain_item};
+
+const KEYCHAIN_SERVICE: &str = "xyz.tea.BASE.bpb";
+const KEYCHAIN_ACCOUNT: &str = "example_account";
 
 #[derive(Serialize, Deserialize)]
 pub struct Config {
@@ -38,17 +40,14 @@ impl Config {
     }
 
     pub fn load() -> Result<Config, Error> {
-      let service = "xyz.tea.BASE.bpb";
-      let account = "example_account";
-      let str = get_keychain_item(service, account)?;
-      Ok(toml::from_str::<Config>(&str)?)
+        let str = get_keychain_item(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT)?;
+        Ok(toml::from_str::<Config>(&str)?)
     }
 
     pub fn write(&self) -> Result<(), Error> {
         let secret = toml::to_string(self)?;
-        let service = "xyz.tea.BASE.bpb";
-        let account = "example_account"; //self.user_id();
-        add_keychain_item(service, account, &secret)
+        // let account = self.user_id();
+        add_keychain_item(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT, &secret)
     }
 
     pub fn timestamp(&self) -> u64 {
@@ -79,11 +78,11 @@ struct SecretKey {
 
 impl SecretKey {
     fn secret(&self) -> Result<[u8; 32], Error> {
-      if let Some(key) = &self.key {
-        to_32_bytes(key)
-      } else {
-          bail!("No secret key or program specified")
-      }
+        if let Some(key) = &self.key {
+            to_32_bytes(key)
+        } else {
+            bail!("No secret key or program specified")
+        }
     }
 }