chore: rename files in cache module

mitre · Sep 13, 2024 · f447b7c · f447b7c
1 parent 7fb7387
commit f447b7c
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 34 deletions.
diff --git a/hipcheck/src/analysis/mod.rs b/hipcheck/src/analysis/mod.rs
@@ -211,21 +211,3 @@ pub fn typo_analysis(db: &dyn AnalysisProvider) -> Result<QueryResult> {
 		concerns,
 	})
 }
-
-#[allow(unused)]
-fn score_by_threshold<T: PartialOrd>(value: T, threshold: T) -> i64 {
-	if value > threshold {
-		1
-	} else {
-		0
-	}
-}
-
-#[allow(unused)]
-fn score_by_threshold_reversed<T: PartialOrd>(value: T, threshold: T) -> i64 {
-	if value >= threshold {
-		0
-	} else {
-		1
-	}
-}
diff --git a/hipcheck/src/cache/mod.rs b/hipcheck/src/cache/mod.rs
@@ -1,4 +1,4 @@
 // SPDX-License-Identifier: Apache-2.0
 
-pub mod plugin_cache;
-pub mod repo_cache;
+pub mod plugin;
+pub mod repo;
diff --git a/hipcheck/src/cache/plugin_cache.rs → hipcheck/src/cache/plugin.rs b/hipcheck/src/cache/plugin_cache.rs → hipcheck/src/cache/plugin.rs
diff --git a/hipcheck/src/cache/repo_cache.rs → hipcheck/src/cache/repo.rs b/hipcheck/src/cache/repo_cache.rs → hipcheck/src/cache/repo.rs
diff --git a/hipcheck/src/cli.rs b/hipcheck/src/cli.rs
@@ -3,7 +3,7 @@
 //! Data structures for Hipcheck's main CLI.
 
 use crate::{
-	cache::repo_cache::{RepoCacheDeleteScope, RepoCacheListScope, RepoCacheSort},
+	cache::repo::{RepoCacheDeleteScope, RepoCacheListScope, RepoCacheSort},
 	error::Context,
 	error::Result,
 	hc_error,

diff --git a/hipcheck/src/engine.rs b/hipcheck/src/engine.rs
@@ -2,7 +2,7 @@
 
 pub use crate::plugin::{HcPluginCore, PluginExecutor, PluginWithConfig};
 use crate::{
-	cache::plugin_cache::HcPluginCache,
+	cache::plugin::HcPluginCache,
 	hc_error,
 	plugin::{
 		get_plugin_key, retrieve_plugins, Plugin, PluginManifest, PluginResponse, QueryResult,

diff --git a/hipcheck/src/main.rs b/hipcheck/src/main.rs
@@ -29,7 +29,7 @@ pub mod hipcheck {
 
 use crate::{
 	analysis::score::score_results,
-	cache::repo_cache::HcRepoCache,
+	cache::repo::HcRepoCache,
 	cli::Format,
 	config::WeightTreeProvider,
 	error::{Context as _, Error, Result},

diff --git a/hipcheck/src/plugin/download_manifest.rs b/hipcheck/src/plugin/download_manifest.rs
@@ -2,7 +2,7 @@
 
 use super::{PluginId, PluginManifest, PluginName, PluginPublisher, PluginVersion};
 use crate::{
-	cache::plugin_cache::HcPluginCache,
+	cache::plugin::HcPluginCache,
 	error::Error,
 	hc_error,
 	plugin::{

diff --git a/hipcheck/src/plugin/retrieval.rs b/hipcheck/src/plugin/retrieval.rs
@@ -2,7 +2,7 @@
 
 use super::{DownloadManifest, PluginId};
 use crate::{
-	cache::plugin_cache::HcPluginCache,
+	cache::plugin::HcPluginCache,
 	config::MITRE_PUBLISHER,
 	error::Error,
 	hc_error,

diff --git a/hipcheck/src/report/mod.rs b/hipcheck/src/report/mod.rs
@@ -371,7 +371,6 @@ pub enum Analysis {
 		#[serde(skip)]
 		passed: bool,
 	},
-	#[allow(unused)]
 	/// Plugin analysis.
 	Plugin {
 		/// The name of the plugin.
@@ -380,7 +379,7 @@ pub enum Analysis {
 		///
 		/// Same as with the message, this is computed eagerly in the case of
 		/// plugin analyses.
-		is_passing: bool,
+		passed: bool,
 		/// The policy expression used for the plugin.
 		///
 		/// We use this when printing the result to help explain to the user
@@ -440,10 +439,10 @@ impl Analysis {
 	percent_constructor!(identity);
 	percent_constructor!(review);
 
-	pub fn plugin(name: String, is_passing: bool, policy_expr: String, message: String) -> Self {
+	pub fn plugin(name: String, passed: bool, policy_expr: String, message: String) -> Self {
 		Analysis::Plugin {
 			name,
-			is_passing,
+			passed,
 			policy_expr,
 			message,
 		}
@@ -478,9 +477,7 @@ impl Analysis {
 			| Entropy { passed, .. }
 			| Identity { passed, .. }
 			| Review { passed, .. }
-			| Plugin {
-				is_passing: passed, ..
-			} => *passed,
+			| Plugin { passed, .. } => *passed,
 		}
 	}
 
@@ -554,7 +551,14 @@ impl Analysis {
 				(false, true) => "too many concerning dependency names".to_string(),
 				(false, false) => "has concerning dependency names".to_string(),
 			},
-			Plugin { policy_expr, .. } => format!("failed to meet policy: ({policy_expr})"),
+			Plugin {
+				policy_expr,
+				passed,
+				..
+			} => match passed {
+				true => "satisfied associated policy".to_owned(),
+				false => format!("failed to meet policy: ({policy_expr})"),
+			},
 		}
 	}
 

diff --git a/hipcheck/src/session/mod.rs b/hipcheck/src/session/mod.rs
@@ -6,7 +6,7 @@ pub mod spdx;
 
 use crate::{
 	analysis::{score::ScoringProviderStorage, AnalysisProviderStorage},
-	cache::plugin_cache::HcPluginCache,
+	cache::plugin::HcPluginCache,
 	cli::Format,
 	config::{
 		AttacksConfigQueryStorage, CommitConfigQueryStorage, Config, ConfigSource,