Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[server] Add admin user remove #824 #925

Merged
merged 2 commits into from
Dec 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions agdb_server/openapi/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,51 @@
]
}
},
"/api/v1/admin/user/{username}/remove": {
"post": {
"tags": [
"crate::routes::admin::user"
],
"operationId": "remove",
"parameters": [
{
"name": "username",
"in": "path",
"description": "user name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "user removed",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserStatus"
}
}
}
}
},
"401": {
"description": "unauthorized"
},
"404": {
"description": "user not found"
}
},
"security": [
{
"Token": []
}
]
}
},
"/api/v1/db/admin/{owner}/{db}/restore": {
"post": {
"tags": [
Expand Down
1 change: 1 addition & 0 deletions agdb_server/src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ use utoipa::OpenApi;
crate::routes::admin::user::change_password,
crate::routes::admin::user::add,
crate::routes::admin::user::list,
crate::routes::admin::user::remove,
crate::routes::admin::shutdown,
crate::routes::user::login,
crate::routes::user::change_password,
Expand Down
4 changes: 4 additions & 0 deletions agdb_server/src/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ pub(crate) fn app(config: Config, shutdown_sender: Sender<()>, db_pool: DbPool)
"/admin/user/:user/change_password",
routing::put(routes::admin::user::change_password),
)
.route(
"/admin/user/:user/remove",
routing::post(routes::admin::user::remove),
)
.route("/admin/db/list", routing::get(routes::admin::db::list))
.route(
"/admin/db/:user/:db/add",
Expand Down
39 changes: 39 additions & 0 deletions agdb_server/src/db_pool.rs
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,27 @@ impl DbPool {
Ok(self.get_pool_mut()?.remove(&db_name).unwrap())
}

pub(crate) fn remove_user(&self, username: &str, config: &Config) -> ServerResult {
let user_id = self.find_user_id(username)?;
let dbs = self.find_user_databases(user_id)?;
for db in dbs.iter() {
self.get_pool_mut()?.remove(&db.name);
}
let mut ids = dbs
.into_iter()
.map(|db| db.db_id.unwrap())
.collect::<Vec<DbId>>();
ids.push(user_id);
self.db_mut()?
.exec_mut(&QueryBuilder::remove().ids(ids).query())?;
let user_dir = Path::new(&config.data_dir).join(username);
if user_dir.exists() {
std::fs::remove_dir_all(user_dir)?;
}

Ok(())
}

pub(crate) fn rename_db(
&self,
owner: &str,
Expand Down Expand Up @@ -907,6 +928,24 @@ impl DbPool {
.try_into()?)
}

fn find_user_databases(&self, user: DbId) -> ServerResult<Vec<Database>> {
Ok(self
.db()?
.exec(
&QueryBuilder::select()
.ids(
QueryBuilder::search()
.depth_first()
.from(user)
.where_()
.distance(CountComparison::Equal(2))
.query(),
)
.query(),
)?
.try_into()?)
}

fn find_user_db_id(&self, user: DbId, db: &str) -> ServerResult<DbId> {
let db_id_query = self.find_user_db_id_query(user, db);
Ok(self
Expand Down
24 changes: 24 additions & 0 deletions agdb_server/src/routes/admin/user.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use crate::config::Config;
use crate::db_pool::DbPool;
use crate::db_pool::ServerUser;
use crate::error_code::ErrorCode;
Expand Down Expand Up @@ -104,3 +105,26 @@ pub(crate) async fn list(
.collect();
Ok((StatusCode::OK, Json(users)))
}

#[utoipa::path(post,
path = "/api/v1/admin/user/{username}/remove",
security(("Token" = [])),
params(
("username" = String, Path, description = "user name"),
),
responses(
(status = 204, description = "user removed", body = Vec<UserStatus>),
(status = 401, description = "unauthorized"),
(status = 404, description = "user not found"),
)
)]
pub(crate) async fn remove(
_admin: AdminId,
State(db_pool): State<DbPool>,
State(config): State<Config>,
Path(username): Path<String>,
) -> ServerResponse {
db_pool.remove_user(&username, &config)?;

Ok(StatusCode::NO_CONTENT)
}
123 changes: 123 additions & 0 deletions agdb_server/tests/routes/admin_user_remove_test.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
use crate::Db;
use crate::TestServer;
use crate::DB_LIST_URI;
use crate::NO_TOKEN;
use std::path::Path;

#[tokio::test]
async fn remove() -> anyhow::Result<()> {
let server = TestServer::new().await?;
let user = server.init_user().await?;

assert_eq!(
server
.post::<()>(
&format!("/admin/user/{}/remove", user.name),
&None,
&server.admin_token
)
.await?
.0,
204
);

Ok(())
}

#[tokio::test]
async fn remove_with_other() -> anyhow::Result<()> {
let server = TestServer::new().await?;
let user = server.init_user().await?;
let other = server.init_user().await?;
let db = server.init_db("mapped", &user).await?;

assert_eq!(
server
.put::<()>(
&format!("/admin/db/{db}/user/{}/add?db_role=write", other.name),
&None,
&server.admin_token
)
.await?,
201
);

let list = server.get::<Vec<Db>>(DB_LIST_URI, &other.token).await?.1;
assert_eq!(
list?,
vec![Db {
name: db,
db_type: "mapped".to_string(),
role: "write".to_string(),
size: 2600,
backup: 0,
}]
);

assert!(Path::new(&server.data_dir).join(&user.name).exists());

assert_eq!(
server
.post::<()>(
&format!("/admin/user/{}/remove", user.name),
&None,
&server.admin_token
)
.await?
.0,
204
);

assert!(!Path::new(&server.data_dir).join(user.name).exists());

let list = server.get::<Vec<Db>>(DB_LIST_URI, &other.token).await?.1;
assert_eq!(list?, vec![]);

Ok(())
}

#[tokio::test]
async fn user_not_found() -> anyhow::Result<()> {
let server = TestServer::new().await?;

assert_eq!(
server
.post::<()>("/admin/user/not_found/remove", &None, &server.admin_token)
.await?
.0,
404
);

Ok(())
}

#[tokio::test]
async fn non_admin() -> anyhow::Result<()> {
let server = TestServer::new().await?;
let user = server.init_user().await?;

assert_eq!(
server
.post::<()>("/admin/user/not_found/remove", &None, &user.token)
.await?
.0,
401
);

Ok(())
}

#[tokio::test]
async fn no_token() -> anyhow::Result<()> {
let server = TestServer::new().await?;

assert_eq!(
server
.post::<()>("/admin/user/not_found/remove", &None, NO_TOKEN)
.await?
.0,
401
);

Ok(())
}
1 change: 1 addition & 0 deletions agdb_server/tests/routes/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ mod admin_db_user_remove_test;
mod admin_user_add_test;
mod admin_user_change_password_test;
mod admin_user_list_test;
mod admin_user_remove_test;
mod db_add_test;
mod db_backup_restore_test;
mod db_copy_test;
Expand Down