Merge pull request #645 from flavio/enable-crate-typos

test: check typos

Author: fabriziosestito

.github/workflows/tests.yml

@@ -84,6 +84,16 @@ jobs:
         with:
           command: clippy
           args: --workspace -- -D warnings
+
+  spelling:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+      - name: Spell Check Repo
+        uses: crate-ci/typos@db35ee91e80fbb447f33b0e5fbddb24d2a1a884f # v1.29.10
+
   coverage:
     name: coverage
     runs-on: ubuntu-latest

.typos.toml

@@ -0,0 +1,8 @@
+[default]
+extend-ignore-re = [
+    "(?Rm)^.*(#|//)\\s*spellchecker:disable-line$",
+    "(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on",
+]
+
+[files]
+extend-exclude = ["*.md", "*.toml"]

Makefile

@@ -16,6 +16,10 @@ lint:
 check:
 	K8S_OPENAPI_ENABLED_VERSION=$(KUBE_API_VERSION) cargo check
 
+.PHONY: typos
+typos:
+	typos # run typo checker from crate-ci/typos
+
 .PHONY: test
 test: fmt lint
 	cargo test --workspace

crates/burrego/src/stack_helper.rs

@@ -30,17 +30,17 @@ impl StackHelper {
         let opa_json_dump_fn = instance
             .get_typed_func::<i32, i32>(store.as_context_mut(), "opa_json_dump")
             .map_err(|e| {
-                BurregoError::RegoWasmError(format!("cannot access opa_json_dump fuction: {e:?}"))
+                BurregoError::RegoWasmError(format!("cannot access opa_json_dump function: {e:?}"))
             })?;
         let opa_malloc_fn = instance
             .get_typed_func::<i32, i32>(store.as_context_mut(), "opa_malloc")
             .map_err(|e| {
-                BurregoError::RegoWasmError(format!("Cannot access opa_malloc fuction: {e:?}"))
+                BurregoError::RegoWasmError(format!("Cannot access opa_malloc function: {e:?}"))
             })?;
         let opa_json_parse_fn = instance
             .get_typed_func::<(i32, i32), i32>(store.as_context_mut(), "opa_json_parse")
             .map_err(|e| {
-                BurregoError::RegoWasmError(format!("Cannot access opa_json_parse fuction: {e:?}"))
+                BurregoError::RegoWasmError(format!("Cannot access opa_json_parse function: {e:?}"))
             })?;
 
         let builtins_fn = instance

src/callback_handler/crypto.rs

@@ -151,6 +151,7 @@ mod tests {
     };
     use kubewarden_policy_sdk::host_capabilities::crypto_v1::CertificateVerificationRequest;
 
+    // spellchecker:off
     const ROOT_CA1_PEM: &str = "-----BEGIN CERTIFICATE-----
 MIICSTCCAfCgAwIBAgIUQS1sQWI6HCOK5vsO2DDHqWZER7swCgYIKoZIzj0EAwIw
 gYIxCzAJBgNVBAYTAkRFMRAwDgYDVQQIEwdCYXZhcmlhMRIwEAYDVQQHEwlOdXJl
@@ -236,6 +237,7 @@ EHuCFAQE5thiOSoEqilZAzAfBgNVHSMEGDAWgBR1uDPhKH7EjlGO2axbPKlTgy8j
 iDAKBggqhkjOPQQDAgNIADBFAiEArSsdE5dDXqAU2vM3ThT8GvTnjkWhER3l9v1j
 3ka2eiMCIBIMXVLY+XGEHNdarxDj8XKQurNf6Nngs0nU+5ggyF4F
 -----END CERTIFICATE-----";
+    // spellchecker:on
 
     #[test]
     fn certificate_is_trusted() {

src/policy_evaluator.rs

@@ -69,7 +69,7 @@ impl TryFrom<PolicyExecutionMode> for RegoPolicyExecutionMode {
             PolicyExecutionMode::Opa => Ok(RegoPolicyExecutionMode::Opa),
             PolicyExecutionMode::OpaGatekeeper => Ok(RegoPolicyExecutionMode::Gatekeeper),
             PolicyExecutionMode::KubewardenWapc | PolicyExecutionMode::Wasi => Err(anyhow!(
-                "execution mode not convertible to a Rego based executon mode"
+                "execution mode not convertible to a Rego based execution mode"
             )),
         }
     }

src/runtimes/rego/stack_pre.rs

@@ -9,9 +9,9 @@ use crate::runtimes::rego::errors::{RegoRuntimeError, Result};
 /// to reduce the instantiation times. That happens because all
 /// Rego WebAssembly policies import their Wasm Memory from the host.
 /// The Wasm Memory is defined inside of a `wasmtime::Store`, which is
-/// something that `wasmtime::InstnacePre` objects do not have (rightfully!).
+/// something that `wasmtime::InstancePre` objects do not have (rightfully!).
 ///
-/// However, Rego Wasm modules are so small thta instantiating them from scratch
+/// However, Rego Wasm modules are so small that instantiating them from scratch
 /// is already a cheap operation.
 #[derive(Clone)]
 pub(crate) struct StackPre {

tests/data/endless_wasm/README.md

@@ -21,7 +21,7 @@ This is a module meant to be used by a waPC host.
 
 This code cheats a little, from the outside it looks like any regular waPC module
 because it exposes the two functions required by a waPC host. However, these
-two functions are reduced to the bare mimimum.
+two functions are reduced to the bare minimum.
 
 The most important difference is that no waPC function is registered by the
 module. Calling any kind of waPC function from the host will result in an

tests/data/endless_wasm/wapc_endless_loop.wat

@@ -2,7 +2,7 @@
 ;;
 ;; This code cheats a little, from the outside it looks like any regular waPC module
 ;; because it exposes the two functions required by a waPC host. However, these
-;; two functions are reduced to the bare mimimum.
+;; two functions are reduced to the bare minimum.
 ;;
 ;; The most important difference is that no waPC function is registered by the
 ;; module. Calling any kind of waPC function from the host will result in an