Merge #849

bors[bot] · Bromeon · web-flow · commit 2c685ab477e4 · 2022-01-19T09:15:58.000Z
849: Add cargo-deny to CI r=Bromeon a=Bromeon [**cargo-deny**](https://github.com/EmbarkStudios/cargo-deny) is a tool that scans the dependency tree and checks for: * RustSec [security vulnerabilities](https://github.com/rustsec/advisory-db) * unmaintained/yanked crates * crates from non-approved registries (e.g. Git dependencies) * incompatible/disallowed licenses * banned crates It's not something that we _absolutely_ need. If it negatively affects CI, we can also not add it or remove it again in the future. Possible alternatives: * [cargo-audit](https://github.com/RustSec/rustsec/tree/main/cargo-audit) -- seems to have less functionality than cargo-deny * GitHub's [dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates) -- checks for updates. While it partially overlaps with cargo-deny, I think the two complement each other. I've set the rules rather strict for now (see 2nd commit), because a CI passing with warnings will never be noticed. If it limits us, we can continuously add exceptions or soften the rules. Co-authored-by: Jan Haller <bromeon@gmail.com>
diff --git a/.github/workflows/full-ci.yml b/.github/workflows/full-ci.yml
@@ -33,6 +33,7 @@ env:
   # Local variables
   # Note: using variables is limited at the moment, see https://github.com/actions/runner/issues/480
   GDRUST_FEATURES: "gdnative/async,gdnative/serde"
+  CARGO_DENY_VERSION: "0.11.0"
 
 on:
   push:
@@ -78,6 +79,21 @@ jobs:
       - name: "Check clippy"
         run: cargo clippy --workspace --features ${GDRUST_FEATURES} -- -D clippy::style -D clippy::complexity -D clippy::perf -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented;
 
+  cargo-deny:
+    runs-on: ubuntu-latest
+    needs: rustfmt
+    steps:
+      - uses: actions/checkout@v2
+      # Note: manually downloading is ~30s faster than https://github.com/EmbarkStudios/cargo-deny-action
+      - name: "Install cargo-deny"
+        run: |
+          wget --no-verbose https://github.com/EmbarkStudios/cargo-deny/releases/download/$CARGO_DENY_VERSION/cargo-deny-$CARGO_DENY_VERSION-x86_64-unknown-linux-musl.tar.gz -O cargo-deny.tar.gz
+          tar -zxvf cargo-deny.tar.gz
+          mkdir -p $HOME/.cargo/bin
+          mv cargo-deny-$CARGO_DENY_VERSION-x86_64-unknown-linux-musl/cargo-deny $HOME/.cargo/bin
+      - name: "Check cargo-deny"
+        run: cargo deny check --config tools/deny.toml
+
   test:
     name: test-${{ matrix.os.name }}${{ matrix.rust.postfix }}
     needs: rustfmt
@@ -271,6 +287,7 @@ jobs:
     needs:
       #- rustfmt
       - clippy
+      - cargo-deny
       - test
       - integration-test-godot
       - build-release
diff --git a/examples/array_export/Cargo.toml b/examples/array_export/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/dodge_the_creeps/Cargo.toml b/examples/dodge_the_creeps/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/hello_world/Cargo.toml b/examples/hello_world/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/native_plugin/Cargo.toml b/examples/native_plugin/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/resource/Cargo.toml b/examples/resource/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/rpc/Cargo.toml b/examples/rpc/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/scene_create/Cargo.toml b/examples/scene_create/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/signals/Cargo.toml b/examples/signals/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 edition = "2018"
 publish = false
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/examples/spinning_cube/Cargo.toml b/examples/spinning_cube/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors = ["The godot-rust developers"]
 publish = false
 edition = "2018"
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/test/Cargo.toml b/test/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 workspace = ".."
 edition = "2018"
 publish = false
+license = "MIT"
 
 [lib]
 crate-type = ["cdylib"]
@@ -21,7 +22,6 @@ ron = "0.7.0"
 serde = "1.0.130"
 serde_json = "1.0.68"
 bincode = "1.3.3"
-serde_cbor = "0.11.2"
 serde_yaml = "0.8.21"
 rmp-serde = "0.15.5"
 futures = "0.3.17"
diff --git a/test/src/test_serde.rs b/test/src/test_serde.rs
@@ -16,7 +16,6 @@ pub(crate) fn run_tests() -> bool {
     status &= test_ron();
     status &= test_json();
     status &= test_yaml();
-    status &= test_cbor();
     status &= test_msgpack();
     status &= test_bincode();
 
@@ -232,32 +231,6 @@ fn test_yaml() -> bool {
     ok
 }
 
-fn test_cbor() -> bool {
-    println!("   -- test_cbor");
-
-    let ok = std::panic::catch_unwind(|| {
-        let foo = Foo::new();
-
-        let cbor_bytes = serde_cbor::to_vec(&foo).expect("Foo to CBOR");
-        let result = serde_cbor::from_slice::<Foo>(&cbor_bytes).expect("Foo from CBOR");
-        assert_eq!(foo, result);
-
-        let cbor_bytes =
-            serde_cbor::to_vec(&foo.to_variant().dispatch()).expect("Dispatch to CBOR");
-        let disp =
-            serde_cbor::from_slice::<VariantDispatch>(&cbor_bytes).expect("Dispatch from CBOR");
-        let result = Foo::from_variant(&Variant::from(&disp)).expect("Foo from Dispatch from CBOR");
-        assert_eq!(foo, result);
-    })
-    .is_ok();
-
-    if !ok {
-        godot_error!("     !! Test test_cbor failed");
-    }
-
-    ok
-}
-
 fn test_msgpack() -> bool {
     println!("   -- test_msgpack");
 
diff --git a/tools/deny.toml b/tools/deny.toml
@@ -0,0 +1,211 @@
+# This template contains all of the possible sections and their default values
+
+# Note that all fields that take a lint level have these possible values:
+# * deny - An error will be produced and the check will fail
+# * warn - A warning will be produced, but the check will not fail
+# * allow - No warning or error will be produced, though in some cases a note
+# will be
+
+# The values provided in this template are the default values that will be used
+# when any section or field is not specified in your own configuration
+
+# If 1 or more target triples (and optionally, target_features) are specified,
+# only the specified targets will be checked when running `cargo deny check`.
+# This means, if a particular package is only ever used as a target specific
+# dependency, such as, for example, the `nix` crate only being used via the
+# `target_family = "unix"` configuration, that only having windows targets in
+# this list would mean the nix crate, as well as any of its exclusive
+# dependencies not shared by any other crates, would be ignored, as the target
+# list here is effectively saying which targets you are building for.
+targets = [
+    # The triple can be any string, but only the target triples built in to
+    # rustc (as of 1.40) can be checked against actual config expressions
+    #{ triple = "x86_64-unknown-linux-musl" },
+    # You can also specify which target_features you promise are enabled for a
+    # particular target. target_features are currently not validated against
+    # the actual valid features supported by the target architecture.
+    #{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
+]
+
+# This section is considered when running `cargo deny check advisories`
+# More documentation for the advisories section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
+[advisories]
+# The path where the advisory database is cloned/fetched into
+db-path = "~/.cargo/advisory-db"
+# The url(s) of the advisory databases to use
+db-urls = ["https://github.com/rustsec/advisory-db"]
+# The lint level for security vulnerabilities
+vulnerability = "deny"
+# The lint level for unmaintained crates
+unmaintained = "deny"
+# The lint level for crates that have been yanked from their source registry
+yanked = "deny"
+# The lint level for crates with security notices. Note that as of
+# 2019-12-17 there are no security notice advisories in
+# https://github.com/rustsec/advisory-db
+notice = "warn"
+# A list of advisory IDs to ignore. Note that ignored advisories will still
+# output a note when they are encountered.
+ignore = [
+    # "RUSTSEC-0000-0000",
+]
+# Threshold for security vulnerabilities, any vulnerability with a CVSS score
+# lower than the range specified will be ignored. Note that ignored advisories
+# will still output a note when they are encountered.
+# * None - CVSS Score 0.0
+# * Low - CVSS Score 0.1 - 3.9
+# * Medium - CVSS Score 4.0 - 6.9
+# * High - CVSS Score 7.0 - 8.9
+# * Critical - CVSS Score 9.0 - 10.0
+#severity-threshold =
+
+# This section is considered when running `cargo deny check licenses`
+# More documentation for the licenses section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
+[licenses]
+# The lint level for crates which do not have a detectable license
+unlicensed = "deny"
+# List of explicitly allowed licenses
+# See https://spdx.org/licenses/ for list of possible licenses
+# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
+allow = [
+    "MIT",
+    "Apache-2.0",
+    "Zlib",
+    "BSD-3-Clause",
+    "ISC",
+    #"Apache-2.0 WITH LLVM-exception",
+]
+# What to do if a license in the above list is not actually used in a dependency
+# We allow this since we don't want to fine-tune deny.toml every time we add/remove
+# a permissive license.
+unused-allowed-license = "allow"
+# Allow 1 or more licenses on a per-crate basis, so that particular licenses
+# aren't accepted for every possible crate as with the normal allow list
+exceptions = [
+    # Each entry is the crate and version constraint, and its specific allow list
+    # { name = "crate", allow = ["License"], version = "*" },
+]
+# List of explicitly disallowed licenses
+# See https://spdx.org/licenses/ for list of possible licenses
+# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
+deny = [
+    #"Nokia",
+]
+# Lint level for licenses considered copyleft
+copyleft = "deny"
+# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
+# * both - The license will be approved if it is both OSI-approved *AND* FSF
+# * either - The license will be approved if it is either OSI-approved *OR* FSF
+# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF
+# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved
+# * neither - This predicate is ignored and the default lint level is used
+allow-osi-fsf-free = "neither"
+# Lint level used when no other predicates are matched
+# 1. License isn't in the allow or deny lists
+# 2. License isn't copyleft
+# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
+default = "deny"
+# The confidence threshold for detecting a license from license text.
+# The higher the value, the more closely the license text must be to the
+# canonical license text of a valid SPDX license file.
+# [possible values: any between 0.0 and 1.0].
+confidence-threshold = 0.8
+
+# Some crates don't have (easily) machine readable licensing information,
+# adding a clarification entry for it allows you to manually specify the
+# licensing information
+#[[licenses.clarify]]
+# The name of the crate the clarification applies to
+#name = "ring"
+# The optional version constraint for the crate
+#version = "*"
+# The SPDX expression for the license requirements of the crate
+#expression = "MIT AND ISC AND OpenSSL"
+# One or more files in the crate's source used as the "source of truth" for
+# the license expression. If the contents match, the clarification will be used
+# when running the license check, otherwise the clarification will be ignored
+# and the crate will be checked normally, which may produce warnings or errors
+# depending on the rest of your configuration
+#license-files = [
+# Each entry is a crate relative path, and the (opaque) hash of its contents
+#{ path = "LICENSE", hash = 0xbd0eed23 }
+#]
+
+[licenses.private]
+# If true, ignores workspace crates that aren't published, or are only
+# published to private registries.
+# To see how to mark a crate as unpublished (to the official registry),
+# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
+ignore = false
+# One or more private registries that you might publish crates to, if a crate
+# is only published to private registries, and ignore is true, the crate will
+# not have its license(s) checked
+registries = [
+    #"https://sekretz.com/registry
+]
+
+# This section is considered when running `cargo deny check bans`.
+# More documentation about the 'bans' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
+[bans]
+# Lint level for when multiple versions of the same crate are detected
+multiple-versions = "warn"
+# Lint level for when a crate version requirement is `*`
+wildcards = "allow"
+# The graph highlighting used when creating dotgraphs for crates
+# with multiple versions
+# * lowest-version - The path to the lowest versioned duplicate is highlighted
+# * simplest-path - The path to the version with the fewest edges is highlighted
+# * all - Both lowest-version and simplest-path are used
+highlight = "all"
+# List of crates that are allowed. Use with care!
+allow = [
+    #{ name = "ansi_term", version = "=0.11.0" },
+]
+# List of crates to deny
+deny = [
+    # Each entry the name of a crate and a version range. If version is
+    # not specified, all versions will be matched.
+    #{ name = "ansi_term", version = "=0.11.0" },
+    #
+    # Wrapper crates can optionally be specified to allow the crate when it
+    # is a direct dependency of the otherwise banned crate
+    #{ name = "ansi_term", version = "=0.11.0", wrappers = [] },
+]
+# Certain crates/versions that will be skipped when doing duplicate detection.
+skip = [
+    #{ name = "ansi_term", version = "=0.11.0" },
+]
+# Similarly to `skip` allows you to skip certain crates during duplicate
+# detection. Unlike skip, it also includes the entire tree of transitive
+# dependencies starting at the specified crate, up to a certain depth, which is
+# by default infinite
+skip-tree = [
+    #{ name = "ansi_term", version = "=0.11.0", depth = 20 },
+]
+
+# This section is considered when running `cargo deny check sources`.
+# More documentation about the 'sources' section can be found here:
+# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
+[sources]
+# Lint level for what to happen when a crate from a crate registry that is not
+# in the allow list is encountered
+unknown-registry = "deny"
+# Lint level for what to happen when a crate from a git repository that is not
+# in the allow list is encountered
+unknown-git = "deny"
+# List of URLs for allowed crate registries. Defaults to the crates.io index
+# if not specified. If it is specified but empty, no registries are allowed.
+allow-registry = ["https://github.com/rust-lang/crates.io-index"]
+# List of URLs for allowed Git repositories
+allow-git = []
+
+[sources.allow-org]
+# 1 or more github.com organizations to allow git sources for
+#github = [""]
+# 1 or more gitlab.com organizations to allow git sources for
+#gitlab = [""]
+# 1 or more bitbucket.org organizations to allow git sources for
+#bitbucket = [""]
