117 lines
3.1 KiB
Rust
117 lines
3.1 KiB
Rust
// Copyright (C) 2021 Aravinth Manivannan <realaravinth@batsense.net>
|
|
// SPDX-FileCopyrightText: 2023 Aravinth Manivannan <realaravinth@batsense.net>
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
use actix_web::{web, HttpResponse, Responder};
|
|
use derive_builder::Builder;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::AppData;
|
|
use crate::{GIT_COMMIT_HASH, VERSION};
|
|
|
|
#[derive(Clone, Debug, Deserialize, Builder, Serialize)]
|
|
pub struct BuildDetails {
|
|
pub version: &'static str,
|
|
pub git_commit_hash: &'static str,
|
|
}
|
|
|
|
pub mod routes {
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
|
|
pub struct Meta {
|
|
pub build_details: &'static str,
|
|
pub health: &'static str,
|
|
}
|
|
|
|
impl Meta {
|
|
pub const fn new() -> Self {
|
|
Self {
|
|
build_details: "/api/v1/meta/build",
|
|
health: "/api/v1/meta/health",
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// emmits build details of the bninary
|
|
#[actix_web_codegen_const_routes::get(path = "crate::V1_API_ROUTES.meta.build_details")]
|
|
async fn build_details() -> impl Responder {
|
|
let build = BuildDetails {
|
|
version: VERSION,
|
|
git_commit_hash: GIT_COMMIT_HASH,
|
|
};
|
|
HttpResponse::Ok().json(build)
|
|
}
|
|
|
|
#[derive(Clone, Debug, Deserialize, Builder, Serialize)]
|
|
/// Health check return datatype
|
|
pub struct Health {
|
|
db: bool,
|
|
}
|
|
|
|
/// checks all components of the system
|
|
#[actix_web_codegen_const_routes::get(path = "crate::V1_API_ROUTES.meta.health")]
|
|
async fn health(data: AppData) -> impl Responder {
|
|
use sqlx::Connection;
|
|
|
|
let mut resp_builder = HealthBuilder::default();
|
|
resp_builder.db(false);
|
|
|
|
if let Ok(mut con) = data.db.acquire().await {
|
|
if con.ping().await.is_ok() {
|
|
resp_builder.db(true);
|
|
}
|
|
};
|
|
HttpResponse::Ok().json(resp_builder.build().unwrap())
|
|
}
|
|
|
|
pub fn services(cfg: &mut web::ServiceConfig) {
|
|
cfg.service(build_details);
|
|
cfg.service(health);
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use actix_web::{http::StatusCode, test, App};
|
|
|
|
use super::*;
|
|
use crate::api::v1::services;
|
|
use crate::tests::get_test_data;
|
|
use crate::*;
|
|
|
|
#[actix_rt::test]
|
|
async fn build_details_works() {
|
|
let app = test::init_service(App::new().configure(services)).await;
|
|
|
|
let resp = test::call_service(
|
|
&app,
|
|
test::TestRequest::get()
|
|
.uri(V1_API_ROUTES.meta.build_details)
|
|
.to_request(),
|
|
)
|
|
.await;
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
}
|
|
|
|
#[actix_rt::test]
|
|
async fn health_works() {
|
|
println!("{}", V1_API_ROUTES.meta.health);
|
|
let data = get_test_data().await;
|
|
let app = get_app!(data).await;
|
|
|
|
let resp = test::call_service(
|
|
&app,
|
|
test::TestRequest::get()
|
|
.uri(V1_API_ROUTES.meta.health)
|
|
.to_request(),
|
|
)
|
|
.await;
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
let health_resp: Health = test::read_body_json(resp).await;
|
|
assert!(health_resp.db);
|
|
}
|
|
}
|