Rename functions to align with arm (#128)

examples/cleanup-orphaned-assignments.rs

@@ -1,5 +1,5 @@
 use anyhow::{Context, Result};
-use azure_pim_cli::{roles::RoleAssignments, ListFilter, PimClient};
+use azure_pim_cli::{models::roles::RoleAssignments, ListFilter, PimClient};
 use clap::Parser;
 use std::{
     io::{stderr, stdin},
@@ -74,7 +74,7 @@ fn main() -> Result<()> {
         }
 
         let mut objects = client
-            .list_assignments(&role_assignment.scope)
+            .role_assignments(&role_assignment.scope)
             .context("unable to list active assignments")?;
         let definitions = client.role_definitions(&role_assignment.scope)?;
         debug!("{} total entries", objects.len());
@@ -97,7 +97,7 @@ fn main() -> Result<()> {
             }
 
             client
-                .delete_assignment(&entry.properties.scope, &entry.name)
+                .delete_role_assignment(&entry.properties.scope, &entry.name)
                 .context("unable to delete assignment")?;
         }
     }

src/backend.rs

@@ -1,6 +1,6 @@
 use crate::{
     az_cli::{extract_oid, get_token, TokenScope},
-    scope::Scope,
+    models::scope::Scope,
 };
 use anyhow::{anyhow, Context, Result};
 use derive_setters::Setters;

src/bin/az-pim.rs

@@ -1,10 +1,12 @@
 use anyhow::{bail, Context, Result};
 use azure_pim_cli::{
-    assignments::Assignment,
     check_latest_version,
     interactive::{interactive_ui, Selected},
-    roles::{Role, RoleAssignments},
-    scope::Scope,
+    models::{
+        assignments::Assignment,
+        roles::{Role, RoleAssignments},
+        scope::Scope,
+    },
     ListFilter, PimClient,
 };
 use clap::{ArgAction, Args, Command, CommandFactory, Parser, Subcommand, ValueHint};
@@ -576,7 +578,7 @@ impl AssignmentSubCommand {
                 let scope = build_scope(subscription, resource_group, scope, provider)?
                     .context("valid scope must be provided")?;
                 let objects = client
-                    .list_assignments(&scope)
+                    .role_assignments(&scope)
                     .context("unable to list active assignments")?;
                 output(&objects)?;
             }
@@ -590,7 +592,7 @@ impl AssignmentSubCommand {
                 let scope = build_scope(subscription, resource_group, scope, provider)?
                     .context("valid scope must be provided")?;
                 client
-                    .delete_assignment(&scope, &assignment_name)
+                    .delete_role_assignment(&scope, &assignment_name)
                     .context("unable to delete assignment")?;
             }
             Self::DeleteSet { config } => {
@@ -599,7 +601,7 @@ impl AssignmentSubCommand {
                     .context("unable to parse config file")?;
                 for entry in entries {
                     client
-                        .delete_assignment(&entry.properties.scope, &entry.name)
+                        .delete_role_assignment(&entry.properties.scope, &entry.name)
                         .context("unable to delete assignment")?;
                 }
             }
@@ -613,7 +615,7 @@ impl AssignmentSubCommand {
                 let scope = build_scope(subscription, resource_group, scope, provider)?
                     .context("valid scope must be provided")?;
                 let mut objects = client
-                    .list_assignments(&scope)
+                    .role_assignments(&scope)
                     .context("unable to list active assignments")?;
                 let definitions = client.role_definitions(&scope)?;
                 debug!("{} total entries", objects.len());
@@ -636,7 +638,7 @@ impl AssignmentSubCommand {
                     }
 
                     client
-                        .delete_assignment(&entry.properties.scope, &entry.name)
+                        .delete_role_assignment(&entry.properties.scope, &entry.name)
                         .context("unable to delete assignment")?;
                 }
             }

src/interactive.rs

@@ -1,4 +1,4 @@
-use crate::roles::{RoleAssignment, RoleAssignments};
+use crate::models::roles::{RoleAssignment, RoleAssignments};
 use anyhow::Result;
 use ratatui::{
     crossterm::{

src/lib.rs

@@ -9,27 +9,25 @@
 #![allow(clippy::module_name_repetitions)]
 
 mod activate;
-pub mod assignments;
 mod az_cli;
 mod backend;
-mod definitions;
 mod graph;
 pub mod interactive;
 mod latest;
-pub mod resources;
-pub mod roles;
-pub mod scope;
+pub mod models;
 
 pub use crate::latest::check_latest_version;
 use crate::{
     activate::check_error_response,
-    assignments::{Assignment, Assignments},
     backend::Backend,
-    definitions::{Definition, Definitions},
     graph::get_objects_by_ids,
-    resources::ChildResource,
-    roles::{RoleAssignment, RoleAssignments},
-    scope::Scope,
+    models::{
+        assignments::{Assignment, Assignments},
+        definitions::{Definition, Definitions},
+        resources::ChildResource,
+        roles::{RoleAssignment, RoleAssignments},
+        scope::Scope,
+    },
 };
 use anyhow::{bail, ensure, Context, Result};
 use backend::Operation;
@@ -161,6 +159,9 @@ impl PimClient {
     }
 
     /// List the roles active role assignments for the current user
+    ///
+    /// # Errors
+    /// Will return `Err` if the request fails or the response is not valid JSON
     pub fn list_active_role_assignments(
         &self,
         scope: Option<Scope>,
@@ -486,8 +487,11 @@ impl PimClient {
         Ok(())
     }
 
-    /// List all assignments (not just those managed by PIM)
-    pub fn list_assignments(&self, scope: &Scope) -> Result<Vec<Assignment>> {
+    /// List role assignments
+    ///
+    /// # Errors
+    /// Will return `Err` if the request fails or the response is not valid JSON
+    pub fn role_assignments(&self, scope: &Scope) -> Result<Vec<Assignment>> {
         info!("listing assignments for {scope}");
         let value = self
             .backend
@@ -509,6 +513,10 @@ impl PimClient {
         Ok(assignments)
     }
 
+    /// List eligible child resources for the specified scope
+    ///
+    /// # Errors
+    /// Will return `Err` if the request fails or the response is not valid JSON
     pub fn eligible_child_resources(&self, scope: &Scope) -> Result<BTreeSet<ChildResource>> {
         info!("listing eligible child resources for {scope}");
         let value = self
@@ -521,6 +529,9 @@ impl PimClient {
     }
 
     /// List all assignments (not just those managed by PIM)
+    ///
+    /// # Errors
+    /// Will return `Err` if the request fails or the response is not valid JSON
     pub fn role_definitions(&self, scope: &Scope) -> Result<Vec<Definition>> {
         info!("listing role definitions for {scope}");
         let definitions = self
@@ -533,7 +544,11 @@ impl PimClient {
         Ok(definitions.value)
     }
 
-    pub fn delete_assignment(&self, scope: &Scope, assignment_name: &str) -> Result<()> {
+    /// Delete a role assignment
+    ///
+    /// # Errors
+    /// Will return `Err` if the request fails or the response is not valid JSON
+    pub fn delete_role_assignment(&self, scope: &Scope, assignment_name: &str) -> Result<()> {
         info!("deleting assignment {assignment_name} from {scope}");
         self.backend
             .request(Method::DELETE, Operation::RoleAssignments)
@@ -544,11 +559,13 @@ impl PimClient {
         Ok(())
     }
 
-    /// Delete the specified role assignment
+    /// Delete eligibile role assignment
+    ///
+    /// This removes role assignments that are available via PIM.
     ///
     /// # Errors
     /// Will return `Err` if the request fails or the response is not valid JSON
-    pub fn delete_role_assignment(&self, assignment: &RoleAssignment) -> Result<()> {
+    pub fn delete_eligible_role_assignment(&self, assignment: &RoleAssignment) -> Result<()> {
         let RoleAssignment {
             scope,
             role_definition_id,

src/assignments.rs → src/models/assignments.rs

@@ -1,4 +1,4 @@
-use crate::{graph::Object, scope::Scope};
+use crate::{graph::Object, models::scope::Scope};
 use serde::{Deserialize, Serialize};
 
 #[derive(Deserialize, Debug, Serialize)]
@@ -52,7 +52,7 @@ mod tests {
 
     #[test]
     fn test_deserialization() -> Result<()> {
-        const DATA: &str = include_str!("../tests/data/assignments.json");
+        const DATA: &str = include_str!("../../tests/data/assignments.json");
         let data: Assignments = serde_json::from_str(DATA)?;
         assert_json_snapshot!(data);
         Ok(())

src/definitions.rs → src/models/definitions.rs

@@ -57,7 +57,7 @@ mod tests {
 
     #[test]
     fn test_deserialization() -> Result<()> {
-        const ROLES: &str = include_str!("../tests/data/definitions.json");
+        const ROLES: &str = include_str!("../../tests/data/definitions.json");
         let definitions: Definitions = serde_json::from_str(ROLES)?;
         assert_json_snapshot!(definitions);
         Ok(())

src/models/mod.rs

@@ -0,0 +1,5 @@
+pub mod assignments;
+pub(crate) mod definitions;
+pub(crate) mod resources;
+pub mod roles;
+pub mod scope;

src/resources.rs → src/models/resources.rs

@@ -1,10 +1,9 @@
+use crate::models::scope::Scope;
 use anyhow::Result;
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use std::collections::BTreeSet;
 
-use crate::scope::Scope;
-
 #[derive(Serialize, Deserialize, PartialOrd, Ord, PartialEq, Eq, Debug)]
 pub struct ChildResource {
     pub id: Scope,
@@ -39,7 +38,7 @@ mod tests {
 
     #[test]
     fn test_child_resource_parse() -> Result<()> {
-        let data: Value = from_str(include_str!("../tests/data/child-resources.json"))?;
+        let data: Value = from_str(include_str!("../../tests/data/child-resources.json"))?;
         let result = ChildResource::parse(&data)?;
         assert_json_snapshot!(result);
         Ok(())

src/roles.rs → src/models/roles.rs

@@ -1,5 +1,7 @@
-use crate::graph::Object;
-use crate::scope::{Scope, ScopeError};
+use crate::{
+    graph::Object,
+    models::scope::{Scope, ScopeError},
+};
 use anyhow::{bail, Result};
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
@@ -172,7 +174,7 @@ mod tests {
 
     #[test]
     fn parse_active() -> Result<()> {
-        const ASSIGNMENTS: &str = include_str!("../tests/data/role-assignments.json");
+        const ASSIGNMENTS: &str = include_str!("../../tests/data/role-assignments.json");
         let assignments = RoleAssignments::parse(&serde_json::from_str(ASSIGNMENTS)?, false)?;
         assert_json_snapshot!(&assignments);
         let assignments = RoleAssignments::parse(&serde_json::from_str(ASSIGNMENTS)?, true)?;

src/snapshots/azure_pim_cli__assignments__tests__deserialization.snap → src/models/snapshots/azure_pim_cli__models__assignments__tests__deserialization.snap

@@ -1,5 +1,5 @@
 ---
-source: src/assignments.rs
+source: src/models/assignments.rs
 expression: data
 ---
 {

src/snapshots/azure_pim_cli__definitions__tests__deserialization.snap → src/models/snapshots/azure_pim_cli__models__definitions__tests__deserialization.snap

@@ -1,5 +1,5 @@
 ---
-source: src/definitions.rs
+source: src/models/definitions.rs
 expression: definitions
 ---
 {

src/snapshots/azure_pim_cli__resources__tests__child_resource_parse.snap → src/models/snapshots/azure_pim_cli__models__resources__tests__child_resource_parse.snap

@@ -1,5 +1,5 @@
 ---
-source: src/resources.rs
+source: src/models/resources.rs
 expression: result
 ---
 [

src/snapshots/azure_pim_cli__roles__tests__parse_active-2.snap → src/models/snapshots/azure_pim_cli__models__roles__tests__parse_active-2.snap

@@ -1,5 +1,5 @@
 ---
-source: src/roles.rs
+source: src/models/roles.rs
 expression: "&assignments"
 ---
 [

src/snapshots/azure_pim_cli__roles__tests__parse_active.snap → src/models/snapshots/azure_pim_cli__models__roles__tests__parse_active.snap

@@ -1,5 +1,5 @@
 ---
-source: src/roles.rs
+source: src/models/roles.rs
 expression: "&assignments"
 ---
 [