1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

// SPDX-FileCopyrightText: 2021 HH Partners
//
// SPDX-License-Identifier: MIT

//! Info about the API.

use serde::Deserialize;

use crate::{Fossology, FossologyError, FossologyResponse};

/// # Errors
///
/// - Error while sending request, redirect loop was detected or redirect limit was exhausted.
/// - Response can't be serialized to [`ApiInformation`] or [`Info`](crate::Info).
/// - Response is not [`ApiInformation`].
pub fn info(fossology: &Fossology) -> Result<ApiInformation, FossologyError> {
    if !fossology.version_is_at_least("1.3.3")? {
        return Err(FossologyError::UnsupportedVersion);
    };

    let response: FossologyResponse<ApiInformation> =
        fossology.init_get_with_token("info").send()?.json()?;

    response.return_response_or_error()
}

/// # Errors
///
/// - Error while sending request, redirect loop was detected or redirect limit was exhausted.
/// - Response can't be serialized to [`ApiInformationV1`] or [`Info`](crate::Info).
/// - Response is not [`ApiInformationV1`].
pub fn version(fossology: &Fossology) -> Result<ApiInformationV1, FossologyError> {
    let response: FossologyResponse<ApiInformationV1> =
        fossology.init_get("version").send()?.json()?;

    response.return_response_or_error()
}

#[derive(Debug, Deserialize)]
pub struct ApiInformationV1 {
    pub version: String,
    pub security: Vec<String>,
}

#[derive(Debug, Deserialize)]
pub struct ApiInformation {
    pub name: String,
    pub description: String,
    pub version: String,
    pub security: Vec<String>,
    pub contact: String,
    pub license: ApiLicense,
}

#[derive(Debug, Deserialize)]
pub struct ApiLicense {
    pub name: String,
    pub url: String,
}

/// # Errors
///
/// - Error while sending request, redirect loop was detected or redirect limit was exhausted.
/// - Response can't be serialized to [`Health`] or [`Info`](crate::Info).
/// - Response is not [`Health`].
pub fn health(fossology: &Fossology) -> Result<Health, FossologyError> {
    if !fossology.version_is_at_least("1.3.3")? {
        return Err(FossologyError::UnsupportedVersion);
    };

    let response: FossologyResponse<Health> = fossology
        .client
        .get(&format!("{}/health", fossology.uri))
        .send()?
        .json()?;
    match response {
        FossologyResponse::Response(res) => Ok(res),
        FossologyResponse::ApiError(res) => Err(FossologyError::Other(res.message)),
    }
}

#[derive(Debug, Deserialize)]
pub struct Health {
    pub status: String,
    pub scheduler: Status,
    pub db: Status,
}

#[derive(Debug, Deserialize)]
pub struct Status {
    pub status: String,
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn api_information() {
        let fossology = Fossology::new("http://localhost:8080/repo/api/v1", "token").unwrap();

        if !fossology.version_is_at_least("1.3.3").unwrap() {
            return;
        };

        let info = info(&fossology).unwrap();
        assert_eq!(info.name, "FOSSology API");
    }

    #[test]
    fn old_version() {
        let fossology = Fossology::new("http://localhost:8080/repo/api/v1", "token").unwrap();

        let info = version(&fossology).unwrap();

        assert_eq!(info.security, vec!["bearerAuth"]);
    }

    #[test]
    fn get_health() {
        let fossology = Fossology::new("http://localhost:8080/repo/api/v1", "token").unwrap();

        if !fossology.version_is_at_least("1.3.3").unwrap() {
            return;
        };

        let health = health(&fossology).unwrap();

        assert_eq!(health.status, "OK");
        assert_eq!(health.scheduler.status, "OK");
        assert_eq!(health.db.status, "OK");
    }
}