Fix a few lints introducedin Rust 1.77 (#348)

* fix a number of new lints in 1.77 * add some comments to investigate something * fix lints in the FFI * use sfio-tracing-ffi 0.8.1 to resolve remaining lints * fix 1.78 beta lints * remove dead code via beta lints * fix more beta lints * fix tests * update allow list * test removing the build log * make a separate bom step * directly install via git url * fix typo * checkout@v3 -> v4 * upload-artifact@v3 -> v4 * update workflow to enrich ffi-modules /w SBOMS * revert back to upload@v3 * revert all uploads to v3 * generate license files from the SBOMs
stepfunc · Apr 1, 2024 · 1b25ad1 · 1b25ad1
1 parent 7f8bcf1
commit 1b25ad1
Show file tree

Hide file tree

Showing 30 changed files with 96 additions and 207 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust ${{ matrix.rust }}
         uses: dtolnay/rust-toolchain@master
         with:
@@ -41,7 +41,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust
         uses: dtolnay/rust-toolchain@master
         with:
@@ -65,7 +65,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust ${{ matrix.rust }}
         uses: dtolnay/rust-toolchain@master
         with:
@@ -80,7 +80,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust ${{ matrix.rust }}
         uses: dtolnay/rust-toolchain@stable
       - name: Install doxygen 1.9.5
@@ -125,7 +125,7 @@ jobs:
             test: false
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust
         uses: dtolnay/rust-toolchain@master
         with:
@@ -137,9 +137,9 @@ jobs:
       - name: Create FFI modules DIR
         run: mkdir ffi-modules\${{ matrix.target }}
       - name: Build FFI
-        run: cargo build -p dnp3-ffi --release --target ${{ matrix.target }} --message-format json | Out-File -encoding "UTF8" .\ffi-modules\${{ matrix.target }}\build.jni.log
+        run: cargo build -p dnp3-ffi --release --target ${{ matrix.target }}
       - name: Build JNI
-        run: cargo build -p dnp3-ffi-java --release --target ${{ matrix.target }} --message-format json | Out-File -encoding "UTF8" .\ffi-modules\${{ matrix.target }}\build.jni.log
+        run: cargo build -p dnp3-ffi-java --release --target ${{ matrix.target }}
       - name: Copy the FFI and JNI libs
         shell: pwsh
         run: |
@@ -170,7 +170,7 @@ jobs:
           - x86_64-apple-darwin # 64-bit macOS (10.7+, Lion+)
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
       - name: Caching
@@ -179,9 +179,9 @@ jobs:
       - name: Create FFI modules dir
         run: mkdir -p ffi-modules/${{ matrix.target }}
       - name: Build FFI
-        run: cargo build -p dnp3-ffi --release --message-format json > ffi-modules/${{ matrix.target }}/build.ffi.log
+        run: cargo build -p dnp3-ffi --release
       - name: Build JNI
-        run: cargo build -p dnp3-ffi-java --release --message-format json > ffi-modules/${{ matrix.target }}/build.jni.log
+        run: cargo build -p dnp3-ffi-java --release
       - name: Copy the FFI and JNI libs
         run: |
           cp ./target/release/libdnp3_ffi.dylib ./ffi-modules/${{ matrix.target }}
@@ -218,7 +218,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
         with:
@@ -231,9 +231,9 @@ jobs:
       - name: Create FFI modules dir
         run: mkdir -p ffi-modules/${{ matrix.target }}
       - name: Build FFI
-        run: cross build -p dnp3-ffi --release --target ${{ matrix.target }} --message-format json > ffi-modules/${{ matrix.target }}/build.ffi.log
+        run: cross build -p dnp3-ffi --release --target ${{ matrix.target }}
       - name: Build JNI
-        run: cross build -p dnp3-ffi-java --release --target ${{ matrix.target }} --message-format json > ffi-modules/${{ matrix.target }}/build.jni.log
+        run: cross build -p dnp3-ffi-java --release --target ${{ matrix.target }}
       - name: Copy the FFI and JNI libs
         run: |
           cp ./target/${{ matrix.target }}/release/libdnp3_ffi.so ./ffi-modules/${{ matrix.target }}
@@ -247,7 +247,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install dependencies
         working-directory: guide
         run: yarn install
@@ -269,35 +269,38 @@ jobs:
     steps:
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
+      - name: Install Cargo CycloneDx
+        run: cargo install cargo-cyclonedx
+      - name: Install custom allow-list tool
+        run: cargo install --git https://github.com/stepfunc/bom-tools.git
       - name: Caching
         if: ${{ !startsWith(github.ref, 'refs/tags/') }}
         uses: Swatinem/rust-cache@v2
-      - name: Checkout BOM tools repo
-        uses: actions/checkout@v3
-        with:
-          repository: stepfunc/bom-tools
-          ref: 0.1.0
-          path: bom-tools
-      - name: Install BOM tools
-        working-directory: bom-tools
-        run: cargo install --path bom-tools
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Download compiled FFI
         uses: actions/download-artifact@v3
         with:
           name: ffi-modules
           path: ffi-modules
+      - name: Create SBOMs
+        run: |
+          for dir in ffi-modules/*; do
+            target=`basename "${dir}"`
+            cargo cyclonedx -f json --target $target
+            mv ./ffi/dnp3-ffi/dnp3-ffi.cdx.json ffi-modules/$target
+            mv ./ffi/dnp3-ffi-java/dnp3-ffi-java.cdx.json ffi-modules/$target
+          done
       - name: Create FFI third-party-licenses.txt
-        run: bom-tools gen-licenses-dir ./ffi-modules build.ffi.log ./dep_config.json > third-party-licenses.txt
+        run: allow-list gen-licenses-dir -l ffi-modules -b dnp3-ffi.cdx.json -c dep_config.json > third-party-licenses.txt
+      - name: Create FFI third-party-licenses-java.txt
+        run: allow-list gen-licenses-dir -l ffi-modules -b dnp3-ffi-java.cdx.json -c dep_config.json > third-party-licenses-java.txt
       - name: Package C/C++ bindings
         run: cargo run --bin dnp3-bindings -- --c --package ./ffi-modules --options ./packaging.json -f third-party-licenses.txt
       - name: Package .NET bindings
         run: cargo run --bin dnp3-bindings -- --dotnet --package ./ffi-modules --options ./packaging.json -f third-party-licenses.txt
-      - name: Create JNI third-party-licenses.txt
-        run: bom-tools gen-licenses-dir ./ffi-modules build.jni.log ./dep_config.json > third-party-licenses.txt
       - name: Package Java bindings
-        run: cargo run --bin dnp3-bindings -- --java --package ./ffi-modules --options ./packaging.json -f third-party-licenses.txt
+        run: cargo run --bin dnp3-bindings -- --java --package ./ffi-modules --options ./packaging.json -f third-party-licenses-java.txt
       - name: Upload C/C++ bindings
         uses: actions/upload-artifact@v3
         with:
@@ -323,7 +326,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
       - name: Caching
@@ -337,7 +340,7 @@ jobs:
         shell: bash
         run: (cd ffi/bindings/java/dnp3 && sudo mvn install)
       - name: Checkout dnp4s
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: stepfunc/dnp4s
           ssh-key: ${{ secrets.DNP4S_SSH_KEY }}
@@ -372,7 +375,7 @@ jobs:
           cd ../conformance-results
           zip -r ../../release/conformance-results.zip .
       - name: Checkout stepfunc/docs
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: stepfunc/docs
           ssh-key: ${{ secrets.SFIO_DOCS_SSH_KEY }}

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/dep_config.json b/dep_config.json
@@ -632,6 +632,23 @@
         }
       ]
     },
+    "getrandom": {
+      "id": "getrandom",
+      "source": "crates.io",
+      "authors": null,
+      "licenses": [
+        {
+          "MIT": {
+            "copyright": {
+              "Lines": [
+                "Copyright (c) 2018-2024 The rust-random Project Developers",
+                "Copyright (c) 2014 The Rust Project Developers"
+              ]
+            }
+          }
+        }
+      ]
+    },
     "hmac": {
       "id": "hmac",
       "source": "crates.io",

diff --git a/dnp3/src/app/attr.rs b/dnp3/src/app/attr.rs
@@ -1042,7 +1042,7 @@ impl Display for BadAttribute {
 
 pub(crate) enum AttrWriteError {
     /// underlying cursor error
-    Cursor(WriteError),
+    Cursor,
     /// attribute value could not be encoded
     BadAttribute(BadAttribute),
 }
@@ -1054,8 +1054,8 @@ impl From<BadAttribute> for AttrWriteError {
 }
 
 impl From<WriteError> for AttrWriteError {
-    fn from(err: WriteError) -> Self {
-        AttrWriteError::Cursor(err)
+    fn from(_: WriteError) -> Self {
+        AttrWriteError::Cursor
     }
 }
 
@@ -1472,7 +1472,7 @@ impl<'a> Attribute<'a> {
 impl From<AttrWriteError> for TaskError {
     fn from(value: AttrWriteError) -> Self {
         match value {
-            AttrWriteError::Cursor(_) => TaskError::WriteError,
+            AttrWriteError::Cursor => TaskError::WriteError,
             AttrWriteError::BadAttribute(x) => TaskError::BadEncoding(BadEncoding::Attribute(x)),
         }
     }

diff --git a/dnp3/src/app/extensions.rs b/dnp3/src/app/extensions.rs
@@ -1,5 +1,4 @@
 use crate::app::control::*;
-use crate::app::measurement::Flags;
 use crate::app::measurement::*;
 use crate::app::{FunctionCode, QualifierCode};
 use crate::util::bit::bits::{BIT_6, BIT_7};

diff --git a/dnp3/src/app/parse/traits.rs b/dnp3/src/app/parse/traits.rs
@@ -20,10 +20,6 @@ pub(crate) trait Index: Copy + Clone + FixedSize + PartialEq + Display {
     fn next(self) -> Self;
     fn widen_to_u16(self) -> u16;
 
-    fn is_zero(&self) -> bool {
-        *self == Self::zero()
-    }
-
     fn one() -> Self {
         Self::zero().next()
     }

diff --git a/dnp3/src/app/types.rs b/dnp3/src/app/types.rs
@@ -1,4 +1,3 @@
-use std::convert::TryFrom;
 use std::time::{Duration, SystemTime};
 
 use crate::app::measurement::DoubleBit;

diff --git a/dnp3/src/lib.rs b/dnp3/src/lib.rs
@@ -11,7 +11,6 @@ patterns_in_fns_without_body,
 pub_use_of_private_extern_crate,
 unknown_crate_types,
 order_dependent_trait_objects,
-illegal_floating_point_literal_pattern,
 improper_ctypes,
 late_bound_lifetime_arguments,
 non_camel_case_types,

diff --git a/dnp3/src/link/format.rs b/dnp3/src/link/format.rs
@@ -47,7 +47,7 @@ impl<'a> FrameData<'a> {
 // this can all be statically verified not to panic since the buffer is a constant length
 pub(crate) fn format_header_fixed_size(
     header: Header,
-    buffer: &mut [u8; super::constant::LINK_HEADER_LENGTH],
+    buffer: &mut [u8; constant::LINK_HEADER_LENGTH],
 ) {
     fn to_le(x: u16) -> (u8, u8) {
         let low = (x & 0xFF) as u8;

diff --git a/dnp3/src/link/parser.rs b/dnp3/src/link/parser.rs
@@ -16,14 +16,14 @@ enum ParseState {
 
 pub(crate) struct FramePayload {
     length: usize,
-    buffer: [u8; super::constant::MAX_FRAME_PAYLOAD_LENGTH],
+    buffer: [u8; constant::MAX_FRAME_PAYLOAD_LENGTH],
 }
 
 impl FramePayload {
     pub(crate) fn new() -> Self {
         Self {
             length: 0,
-            buffer: [0; super::constant::MAX_FRAME_PAYLOAD_LENGTH],
+            buffer: [0; constant::MAX_FRAME_PAYLOAD_LENGTH],
         }
     }
 

diff --git a/dnp3/src/master/file.rs b/dnp3/src/master/file.rs
@@ -129,7 +129,7 @@ impl std::fmt::Display for FileError {
             FileError::NoPermission => f.write_str("no permission"),
             FileError::BadBlockNum => f.write_str("bad block number"),
             FileError::AbortByUser => f.write_str("aborted by user"),
-            FileError::TaskError(t) => std::fmt::Debug::fmt(&t, f),
+            FileError::TaskError(t) => Debug::fmt(&t, f),
             FileError::MaxLengthExceeded => f.write_str("exceeded maximum received length"),
         }
     }

diff --git a/dnp3/src/master/handler.rs b/dnp3/src/master/handler.rs
@@ -2,7 +2,6 @@ use std::time::{Duration, SystemTime};
 
 use crate::app::attr::*;
 use crate::app::measurement::*;
-use crate::app::variations::Variation;
 use crate::app::*;
 
 use crate::decode::DecodeLevel;
@@ -31,7 +30,7 @@ use crate::util::session::Enabled;
 /// Handle to a master communication channel. This handle controls
 /// a task running on the Tokio Runtime.
 ///
-/// It provides a uniform API for all of the various types of communication channels supported
+/// It provides a uniform API for all the various types of communication channels supported
 /// by the library.
 #[derive(Debug, Clone)]
 pub struct MasterChannel {
@@ -461,10 +460,6 @@ pub trait AssociationInformation: Send + Sync {
     fn unsolicited_response(&mut self, _is_duplicate: bool, _seq: Sequence) {}
 }
 
-pub(crate) struct NullAssociationInformation;
-
-impl AssociationInformation for NullAssociationInformation {}
-
 /// Information about the object header and specific variation
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct HeaderInfo {
@@ -645,8 +640,3 @@ pub(crate) fn handle_attribute(
         }
     }
 }
-
-/// read handler that does nothing
-#[derive(Copy, Clone)]
-pub(crate) struct NullReadHandler;
-impl ReadHandler for NullReadHandler {}