Add cargo clippy and cargo deny scans to CI (#36)

* Add strict clippy scanning to crates

This change configures rather pedantic settings for `cargo clippy`.
These crates, as bindings to an underlying API, use a limited subset of
the language so very few settings need to be ignored. If the
`clippy::pedantic` warnings become burdensome in the future, this can be
removed, but this commit makes the necessary changes to run without
warnings.

* ci: add clippy checking to CI workflow

* Use `cargo deny` to check for vulnerable dependencies

This change adds a way in CI to verify that dependencies have no
outstanding vulnerabilities. It also upgrades the regex crate which had
a reported performance-affecting vulnerability.

Author: abrown

.github/workflows/main.yml

@@ -19,9 +19,19 @@ jobs:
         submodules: true
     - run: rustup component add rustfmt
     - run: cargo fmt --all -- --check
+    # Use the `runtime-linking` feature here to avoid requiring an OpenVINO installation to be
+    # present when building.
+    - run: cargo clippy --features runtime-linking
     - run: cd crates/openvino-tensor-converter && cargo fmt --all -- --check
 
-  # Build and test from the git-submodule-included OpenVINO source code. 
+  rust_dependencies:
+    name: Check Rust dependencies
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: EmbarkStudios/cargo-deny-action@v1
+
+  # Build and test from the git-submodule-included OpenVINO source code.
   source:
     name: From source
     runs-on: ubuntu-20.04

Cargo.lock

@@ -0,0 +1 @@
+doc-valid-idents = ["OpenVINO"]

clippy.toml

@@ -7,6 +7,8 @@ readme = "README.md"
 authors = ["OpenVINO Project Developers"]
 repository = "https://github.com/intel/openvino-rs"
 documentation = "https://docs.rs/openvino-finder"
+keywords = ["openvino", "machine-learning", "ml", "neural-network"]
+categories = ["development-tools"]
 edition = "2018"
 
 [dependencies]

crates/openvino-finder/Cargo.toml

@@ -1,3 +1,11 @@
+//! Provides a mechanism for locating the OpenVINO shared libraries installed on a system.
+
+#![deny(missing_docs)]
+#![deny(clippy::all)]
+#![warn(clippy::pedantic)]
+#![warn(clippy::cargo)]
+#![allow(clippy::must_use_candidate)]
+
 use cfg_if::cfg_if;
 use std::env;
 use std::path::PathBuf;
@@ -82,46 +90,46 @@ pub fn find(library_name: &str) -> Option<PathBuf> {
     None
 }
 
-const ENV_OPENVINO_INSTALL_DIR: &'static str = "OPENVINO_INSTALL_DIR";
-const ENV_OPENVINO_BUILD_DIR: &'static str = "OPENVINO_BUILD_DIR";
-const ENV_INTEL_OPENVINO_DIR: &'static str = "INTEL_OPENVINO_DIR";
+const ENV_OPENVINO_INSTALL_DIR: &str = "OPENVINO_INSTALL_DIR";
+const ENV_OPENVINO_BUILD_DIR: &str = "OPENVINO_BUILD_DIR";
+const ENV_INTEL_OPENVINO_DIR: &str = "INTEL_OPENVINO_DIR";
 
 cfg_if! {
     if #[cfg(any(target_os = "linux"))] {
-        const ENV_LIBRARY_PATH: &'static str = "LD_LIBRARY_PATH";
+        const ENV_LIBRARY_PATH: &str = "LD_LIBRARY_PATH";
     } else if #[cfg(target_os = "macos")] {
-        const ENV_LIBRARY_PATH: &'static str = "DYLD_LIBRARY_PATH";
+        const ENV_LIBRARY_PATH: &str = "DYLD_LIBRARY_PATH";
     } else if #[cfg(target_os = "windows")] {
-        const ENV_LIBRARY_PATH: &'static str = "PATH";
+        const ENV_LIBRARY_PATH: &str = "PATH";
     } else {
         // This may not work but seems like a sane default for target OS' not listed above.
-        const ENV_LIBRARY_PATH: &'static str = "LD_LIBRARY_PATH";
+        const ENV_LIBRARY_PATH: &str = "LD_LIBRARY_PATH";
     }
 }
 
 cfg_if! {
     if #[cfg(any(target_os = "linux", target_os = "macos"))] {
-        const DEFAULT_INSTALLATION_DIRECTORIES: &'static [&'static str] =
+        const DEFAULT_INSTALLATION_DIRECTORIES: & [& str] =
             &["/opt/intel/openvino_2021", "/opt/intel/openvino"];
     } else if #[cfg(target_os = "windows")] {
-        const DEFAULT_INSTALLATION_DIRECTORIES: &'static [&'static str] = &[
+        const DEFAULT_INSTALLATION_DIRECTORIES: & [& str] = &[
             "C:\\Program Files (x86)\\Intel\\openvino",
             "C:\\Program Files (x86)\\Intel\\openvino_2021",
         ];
     } else {
-        const DEFAULT_INSTALLATION_DIRECTORIES: &'static [&'static str] = &[];
+        const DEFAULT_INSTALLATION_DIRECTORIES: & [& str] = &[];
     }
 }
 
-const KNOWN_INSTALLATION_SUBDIRECTORIES: &'static [&'static str] = &[
+const KNOWN_INSTALLATION_SUBDIRECTORIES: &[&str] = &[
     "deployment_tools/ngraph/lib",
     "deployment_tools/inference_engine/lib/intel64",
     "deployment_tools/inference_engine/external/hddl/lib",
     "deployment_tools/inference_engine/external/gna/lib",
     "deployment_tools/inference_engine/external/tbb/lib",
 ];
 
-const KNOWN_BUILD_SUBDIRECTORIES: &'static [&'static str] = &[
+const KNOWN_BUILD_SUBDIRECTORIES: &[&str] = &[
     "bin/intel64/Debug/lib",
     "bin/intel64/Release/lib",
     "inference-engine/temp/tbb/lib",

crates/openvino-finder/src/lib.rs

@@ -7,6 +7,8 @@ readme = "README.md"
 authors = ["OpenVINO Project Developers"]
 repository = "https://github.com/intel/openvino-rs"
 documentation = "https://docs.rs/openvino-sys"
+keywords = ["external-ffi-bindings", "openvino", "machine-learning", "ml", "neural-network"]
+categories = ["external-ffi-bindings", "science"]
 edition = "2018"
 include = [
     "/Cargo.toml",

crates/openvino-sys/Cargo.toml

@@ -1,9 +1,8 @@
-use cmake;
 use std::env;
 use std::path::{Path, PathBuf};
 
 // These are the libraries we expect to be available to dynamically link to:
-const LIBRARIES: &'static [&'static str] = &[
+const LIBRARIES: &[&str] = &[
     "inference_engine",
     "inference_engine_legacy",
     "inference_engine_transformations",
@@ -14,11 +13,11 @@ const LIBRARIES: &'static [&'static str] = &[
 
 // A user-specified environment variable indicating that `build.rs` should not attempt to link
 // against any libraries (e.g. a doc build, user may link them later).
-const ENV_OPENVINO_SKIP_LINKING: &'static str = "OPENVINO_SKIP_LINKING";
+const ENV_OPENVINO_SKIP_LINKING: &str = "OPENVINO_SKIP_LINKING";
 
 // A build.rs-specified environment variable that must be populated with the location of the
 // inference engine library that OpenVINO is being linked to in this script.
-const ENV_OPENVINO_LIB_PATH: &'static str = "OPENVINO_LIB_PATH";
+const ENV_OPENVINO_LIB_PATH: &str = "OPENVINO_LIB_PATH";
 
 fn main() {
     // Trigger rebuild on changes to build.rs and Cargo.toml and every source file.

crates/openvino-sys/build.rs

@@ -15,10 +15,14 @@
 //! let version = unsafe { CStr::from_ptr(openvino_sys::ie_c_api_version().api_version) };
 //! assert!(version.to_string_lossy().starts_with("2"));
 //! ```
-#![allow(non_upper_case_globals)]
-#![allow(non_camel_case_types)]
-#![allow(non_snake_case)]
-#![allow(dead_code)]
+
+#![allow(non_snake_case, non_camel_case_types, non_upper_case_globals)]
+#![allow(unused, dead_code)]
+#![deny(clippy::all)]
+#![warn(clippy::pedantic)]
+#![warn(clippy::cargo)]
+#![allow(clippy::must_use_candidate)]
+#![allow(clippy::wildcard_imports)]
 
 mod linking;
 

crates/openvino-sys/src/lib.rs

@@ -12,6 +12,10 @@ macro_rules! link {
     ) => (
         /// When compiled as a dynamically-linked library, this function does nothing. It exists to
         /// provide a consistent API with the runtime-linked version.
+        ///
+        /// # Errors
+        ///
+        /// This version never fails.
         pub fn load() -> Result<(), String> {
             Ok(())
         }

crates/openvino-sys/src/linking/dynamic.rs

@@ -43,10 +43,7 @@ macro_rules! link {
         where
             F: FnOnce(&SharedLibrary) -> T,
         {
-            match LIBRARY.read().unwrap().as_ref() {
-                Some(library) => Some(f(&library)),
-                _ => None,
-            }
+            LIBRARY.read().unwrap().as_ref().map(|library| f(&library))
         }
 
         // The set of functions loaded dynamically.
@@ -74,6 +71,10 @@ macro_rules! link {
         }
 
         /// Load all of the function definitions from a shared library.
+        ///
+        /// # Errors
+        ///
+        /// May fail if the `openvino-finder` cannot discover the library on the current system.
         pub fn load() -> Result<(), String> {
             match crate::library::find() {
                 None => Err("Unable to find the `inference_engine_c_api` library to load".into()),