organizations and projects

Author: david-crespo

Cargo.lock

@@ -545,79 +545,6 @@ pub struct IdentityMetadataUpdateParams {
  * Specific API resources
  */
 
-/*
- * ORGANIZATIONS
- */
-
-/**
- * Client view of an [`Organization`]
- */
-#[derive(ObjectIdentity, Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct Organization {
-    #[serde(flatten)]
-    pub identity: IdentityMetadata,
-}
-
-/**
- * Create-time parameters for an [`Organization`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct OrganizationCreateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataCreateParams,
-}
-
-/**
- * Updateable properties of an [`Organization`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct OrganizationUpdateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataUpdateParams,
-}
-
-/*
- * PROJECTS
- */
-
-/**
- * Client view of an [`Project`]
- */
-#[derive(ObjectIdentity, Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct Project {
-    /*
-     * TODO-correctness is flattening here (and in all the other types) the
-     * intent in RFD 4?
-     */
-    #[serde(flatten)]
-    pub identity: IdentityMetadata,
-    pub organization_id: Uuid,
-}
-
-/**
- * Create-time parameters for an [`Project`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct ProjectCreateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataCreateParams,
-}
-
-/**
- * Updateable properties of an [`Project`]
- */
-#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
-#[serde(rename_all = "camelCase")]
-pub struct ProjectUpdateParams {
-    #[serde(flatten)]
-    pub identity: IdentityMetadataUpdateParams,
-}
-
 /*
  * INSTANCES
  */

common/src/api/external/mod.rs

@@ -35,6 +35,9 @@ structopt = "0.3"
 thiserror = "1.0"
 toml = "0.5.6"
 
+[dependencies.api_identity]
+path = "../api_identity"
+
 [dependencies.chrono]
 version = "0.4"
 features = [ "serde" ]

nexus/Cargo.toml

@@ -24,6 +24,7 @@ use super::identity::{Asset, Resource};
 use super::Pool;
 use crate::authz;
 use crate::context::OpContext;
+use crate::params;
 use async_bb8_diesel::{AsyncRunQueryDsl, ConnectionManager};
 use chrono::Utc;
 use diesel::{ExpressionMethods, QueryDsl, SelectableHelper};
@@ -320,7 +321,7 @@ impl DataStore {
     pub async fn organization_update(
         &self,
         name: &Name,
-        update_params: &api::external::OrganizationUpdateParams,
+        update_params: &params::OrganizationUpdate,
     ) -> UpdateResult<Organization> {
         use db::schema::organization::dsl;
         let updates: OrganizationUpdate = update_params.clone().into();
@@ -496,7 +497,7 @@ impl DataStore {
         &self,
         organization_id: &Uuid,
         name: &Name,
-        update_params: &api::external::ProjectUpdateParams,
+        update_params: &params::ProjectUpdate,
     ) -> UpdateResult<Project> {
         use db::schema::project::dsl;
         let updates: ProjectUpdate = update_params.clone().into();
@@ -1658,11 +1659,9 @@ mod test {
     use crate::db::identity::Resource;
     use crate::db::model::{ConsoleSession, Organization, Project};
     use crate::db::DataStore;
+    use crate::params;
     use chrono::{Duration, Utc};
-    use omicron_common::api::external::{
-        Error, IdentityMetadataCreateParams, OrganizationCreateParams,
-        ProjectCreateParams,
-    };
+    use omicron_common::api::external::{Error, IdentityMetadataCreateParams};
     use omicron_test_utils::dev;
     use std::sync::Arc;
     use uuid::Uuid;
@@ -1676,7 +1675,7 @@ mod test {
         let pool = db::Pool::new(&cfg);
         let datastore = DataStore::new(Arc::new(pool));
 
-        let organization = Organization::new(OrganizationCreateParams {
+        let organization = Organization::new(params::OrganizationCreate {
             identity: IdentityMetadataCreateParams {
                 name: "org".parse().unwrap(),
                 description: "desc".to_string(),
@@ -1687,7 +1686,7 @@ mod test {
 
         let project = Project::new(
             organization.id(),
-            ProjectCreateParams {
+            params::ProjectCreate {
                 identity: IdentityMetadataCreateParams {
                     name: "project".parse().unwrap(),
                     description: "desc".to_string(),

nexus/src/db/datastore.rs

@@ -6,6 +6,7 @@ use crate::db::schema::{
     console_session, disk, instance, metric_producer, network_interface,
     organization, oximeter, project, rack, sled, vpc, vpc_router, vpc_subnet,
 };
+use crate::params;
 use chrono::{DateTime, Utc};
 use db_macros::{Asset, Resource};
 use diesel::backend::{Backend, BinaryRawValue, RawValue};
@@ -339,7 +340,7 @@ pub struct Organization {
 
 impl Organization {
     /// Creates a new database Organization object.
-    pub fn new(params: external::OrganizationCreateParams) -> Self {
+    pub fn new(params: params::OrganizationCreate) -> Self {
         let id = Uuid::new_v4();
         Self {
             identity: OrganizationIdentity::new(id, params.identity),
@@ -355,12 +356,6 @@ impl DatastoreCollection<Project> for Organization {
     type CollectionIdColumn = project::dsl::organization_id;
 }
 
-impl Into<external::Organization> for Organization {
-    fn into(self) -> external::Organization {
-        external::Organization { identity: self.identity() }
-    }
-}
-
 /// Describes a set of updates for the [`Organization`] model.
 #[derive(AsChangeset)]
 #[table_name = "organization"]
@@ -370,8 +365,8 @@ pub struct OrganizationUpdate {
     pub time_modified: DateTime<Utc>,
 }
 
-impl From<external::OrganizationUpdateParams> for OrganizationUpdate {
-    fn from(params: external::OrganizationUpdateParams) -> Self {
+impl From<params::OrganizationUpdate> for OrganizationUpdate {
+    fn from(params: params::OrganizationUpdate) -> Self {
         Self {
             name: params.identity.name.map(|n| n.into()),
             description: params.identity.description,
@@ -392,26 +387,14 @@ pub struct Project {
 
 impl Project {
     /// Creates a new database Project object.
-    pub fn new(
-        organization_id: Uuid,
-        params: external::ProjectCreateParams,
-    ) -> Self {
+    pub fn new(organization_id: Uuid, params: params::ProjectCreate) -> Self {
         Self {
             identity: ProjectIdentity::new(Uuid::new_v4(), params.identity),
             organization_id: organization_id,
         }
     }
 }
 
-impl Into<external::Project> for Project {
-    fn into(self) -> external::Project {
-        external::Project {
-            identity: self.identity(),
-            organization_id: self.organization_id,
-        }
-    }
-}
-
 /// Describes a set of updates for the [`Project`] model.
 #[derive(AsChangeset)]
 #[table_name = "project"]
@@ -421,8 +404,8 @@ pub struct ProjectUpdate {
     pub time_modified: DateTime<Utc>,
 }
 
-impl From<external::ProjectUpdateParams> for ProjectUpdate {
-    fn from(params: external::ProjectUpdateParams) -> Self {
+impl From<params::ProjectUpdate> for ProjectUpdate {
+    fn from(params: params::ProjectUpdate) -> Self {
         Self {
             name: params.identity.name.map(Name),
             description: params.identity.description,

nexus/src/db/model.rs

@@ -2,11 +2,13 @@
  * Handler functions (entrypoints) for external HTTP APIs
  */
 
-use super::ServerContext;
 use crate::db;
 use crate::db::model::Name;
+use crate::ServerContext;
 
+use super::views::{Organization, Project};
 use crate::context::OpContext;
+use crate::params;
 use dropshot::endpoint;
 use dropshot::ApiDescription;
 use dropshot::HttpError;
@@ -38,13 +40,7 @@ use omicron_common::api::external::DiskAttachment;
 use omicron_common::api::external::DiskCreateParams;
 use omicron_common::api::external::Instance;
 use omicron_common::api::external::InstanceCreateParams;
-use omicron_common::api::external::Organization;
-use omicron_common::api::external::OrganizationCreateParams;
-use omicron_common::api::external::OrganizationUpdateParams;
 use omicron_common::api::external::PaginationOrder;
-use omicron_common::api::external::Project;
-use omicron_common::api::external::ProjectCreateParams;
-use omicron_common::api::external::ProjectUpdateParams;
 use omicron_common::api::external::Rack;
 use omicron_common::api::external::Saga;
 use omicron_common::api::external::Sled;
@@ -70,7 +66,7 @@ type NexusApiDescription = ApiDescription<Arc<ServerContext>>;
 /**
  * Returns a description of the external nexus API
  */
-pub fn external_api() -> NexusApiDescription {
+pub fn api() -> NexusApiDescription {
     fn register_endpoints(api: &mut NexusApiDescription) -> Result<(), String> {
         api.register(organizations_get)?;
         api.register(organizations_post)?;
@@ -224,7 +220,7 @@ async fn organizations_get(
 }]
 async fn organizations_post(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
-    new_organization: TypedBody<OrganizationCreateParams>,
+    new_organization: TypedBody<params::OrganizationCreate>,
 ) -> Result<HttpResponseCreated<Organization>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;
@@ -307,7 +303,7 @@ async fn organizations_delete_organization(
 async fn organizations_put_organization(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
     path_params: Path<OrganizationPathParam>,
-    updated_organization: TypedBody<OrganizationUpdateParams>,
+    updated_organization: TypedBody<params::OrganizationUpdate>,
 ) -> Result<HttpResponseOk<Organization>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;
@@ -381,7 +377,7 @@ async fn organization_projects_get(
 async fn organization_projects_post(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
     path_params: Path<OrganizationPathParam>,
-    new_project: TypedBody<ProjectCreateParams>,
+    new_project: TypedBody<params::ProjectCreate>,
 ) -> Result<HttpResponseCreated<Project>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;
@@ -470,7 +466,7 @@ async fn organization_projects_delete_project(
 async fn organization_projects_put_project(
     rqctx: Arc<RequestContext<Arc<ServerContext>>>,
     path_params: Path<ProjectPathParam>,
-    updated_project: TypedBody<ProjectUpdateParams>,
+    updated_project: TypedBody<params::ProjectUpdate>,
 ) -> Result<HttpResponseOk<Project>, HttpError> {
     let apictx = rqctx.context();
     let nexus = &apictx.nexus;

nexus/src/http_entrypoints_external.rs renamed to nexus/src/external_api/http_entrypoints.rs

@@ -0,0 +1,2 @@
+pub mod http_entrypoints;
+pub mod views;

nexus/src/external_api/mod.rs

@@ -0,0 +1,62 @@
+/*!
+ * Views are public lenses onto the DB models.
+ *
+ * Views let us define what fields from the models will be serialized out in
+ * API responses.
+ */
+
+use crate::db::identity::Resource;
+use crate::db::model;
+use api_identity::ObjectIdentity;
+use omicron_common::api::external::{IdentityMetadata, ObjectIdentity};
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+
+/*
+ * ORGANIZATIONS
+ */
+
+/**
+ * Client view of an [`Organization`]
+ */
+#[derive(ObjectIdentity, Clone, Debug, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct Organization {
+    #[serde(flatten)]
+    pub identity: IdentityMetadata,
+}
+
+impl Into<Organization> for model::Organization {
+    fn into(self) -> Organization {
+        Organization { identity: self.identity() }
+    }
+}
+
+/*
+ * PROJECTS
+ */
+
+/**
+ * Client view of an [`Project`]
+ */
+#[derive(ObjectIdentity, Clone, Debug, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct Project {
+    /*
+     * TODO-correctness is flattening here (and in all the other types) the
+     * intent in RFD 4?
+     */
+    #[serde(flatten)]
+    pub identity: IdentityMetadata,
+    pub organization_id: Uuid,
+}
+
+impl Into<Project> for model::Project {
+    fn into(self) -> Project {
+        Project {
+            identity: self.identity(),
+            organization_id: self.organization_id,
+        }
+    }
+}

nexus/src/external_api/views.rs

@@ -1,7 +1,7 @@
 /**
  * Handler functions (entrypoints) for HTTP APIs internal to the control plane
  */
-use super::ServerContext;
+use crate::ServerContext;
 
 use dropshot::endpoint;
 use dropshot::ApiDescription;
@@ -28,7 +28,7 @@ type NexusApiDescription = ApiDescription<Arc<ServerContext>>;
 /**
  * Returns a description of the internal nexus API
  */
-pub fn internal_api() -> NexusApiDescription {
+pub fn api() -> NexusApiDescription {
     fn register_endpoints(api: &mut NexusApiDescription) -> Result<(), String> {
         api.register(cpapi_sled_agents_post)?;
         api.register(cpapi_instances_put)?;

nexus/src/http_entrypoints_internal.rs renamed to nexus/src/internal_api/http_entrypoints.rs

@@ -0,0 +1 @@
+pub mod http_entrypoints;