230 lines
12 KiB
HTML
230 lines
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/meta.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>meta.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../pages/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../pages/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../pages/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
|
||
<span id="2">2</span>
|
||
<span id="3">3</span>
|
||
<span id="4">4</span>
|
||
<span id="5">5</span>
|
||
<span id="6">6</span>
|
||
<span id="7">7</span>
|
||
<span id="8">8</span>
|
||
<span id="9">9</span>
|
||
<span id="10">10</span>
|
||
<span id="11">11</span>
|
||
<span id="12">12</span>
|
||
<span id="13">13</span>
|
||
<span id="14">14</span>
|
||
<span id="15">15</span>
|
||
<span id="16">16</span>
|
||
<span id="17">17</span>
|
||
<span id="18">18</span>
|
||
<span id="19">19</span>
|
||
<span id="20">20</span>
|
||
<span id="21">21</span>
|
||
<span id="22">22</span>
|
||
<span id="23">23</span>
|
||
<span id="24">24</span>
|
||
<span id="25">25</span>
|
||
<span id="26">26</span>
|
||
<span id="27">27</span>
|
||
<span id="28">28</span>
|
||
<span id="29">29</span>
|
||
<span id="30">30</span>
|
||
<span id="31">31</span>
|
||
<span id="32">32</span>
|
||
<span id="33">33</span>
|
||
<span id="34">34</span>
|
||
<span id="35">35</span>
|
||
<span id="36">36</span>
|
||
<span id="37">37</span>
|
||
<span id="38">38</span>
|
||
<span id="39">39</span>
|
||
<span id="40">40</span>
|
||
<span id="41">41</span>
|
||
<span id="42">42</span>
|
||
<span id="43">43</span>
|
||
<span id="44">44</span>
|
||
<span id="45">45</span>
|
||
<span id="46">46</span>
|
||
<span id="47">47</span>
|
||
<span id="48">48</span>
|
||
<span id="49">49</span>
|
||
<span id="50">50</span>
|
||
<span id="51">51</span>
|
||
<span id="52">52</span>
|
||
<span id="53">53</span>
|
||
<span id="54">54</span>
|
||
<span id="55">55</span>
|
||
<span id="56">56</span>
|
||
<span id="57">57</span>
|
||
<span id="58">58</span>
|
||
<span id="59">59</span>
|
||
<span id="60">60</span>
|
||
<span id="61">61</span>
|
||
<span id="62">62</span>
|
||
<span id="63">63</span>
|
||
<span id="64">64</span>
|
||
<span id="65">65</span>
|
||
<span id="66">66</span>
|
||
<span id="67">67</span>
|
||
<span id="68">68</span>
|
||
<span id="69">69</span>
|
||
<span id="70">70</span>
|
||
<span id="71">71</span>
|
||
<span id="72">72</span>
|
||
<span id="73">73</span>
|
||
<span id="74">74</span>
|
||
<span id="75">75</span>
|
||
<span id="76">76</span>
|
||
<span id="77">77</span>
|
||
<span id="78">78</span>
|
||
<span id="79">79</span>
|
||
<span id="80">80</span>
|
||
<span id="81">81</span>
|
||
<span id="82">82</span>
|
||
<span id="83">83</span>
|
||
<span id="84">84</span>
|
||
<span id="85">85</span>
|
||
<span id="86">86</span>
|
||
<span id="87">87</span>
|
||
<span id="88">88</span>
|
||
<span id="89">89</span>
|
||
<span id="90">90</span>
|
||
<span id="91">91</span>
|
||
<span id="92">92</span>
|
||
<span id="93">93</span>
|
||
<span id="94">94</span>
|
||
<span id="95">95</span>
|
||
<span id="96">96</span>
|
||
<span id="97">97</span>
|
||
<span id="98">98</span>
|
||
<span id="99">99</span>
|
||
<span id="100">100</span>
|
||
<span id="101">101</span>
|
||
<span id="102">102</span>
|
||
<span id="103">103</span>
|
||
<span id="104">104</span>
|
||
<span id="105">105</span>
|
||
<span id="106">106</span>
|
||
<span id="107">107</span>
|
||
<span id="108">108</span>
|
||
<span id="109">109</span>
|
||
<span id="110">110</span>
|
||
<span id="111">111</span>
|
||
<span id="112">112</span>
|
||
<span id="113">113</span>
|
||
<span id="114">114</span>
|
||
</pre><pre class="rust"><code><span class="comment">/*
|
||
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||
*
|
||
* This program is free software: you can redistribute it and/or modify
|
||
* it under the terms of the GNU Affero General Public License as
|
||
* published by the Free Software Foundation, either version 3 of the
|
||
* License, or (at your option) any later version.
|
||
*
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* GNU Affero General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU Affero General Public License
|
||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
*/
|
||
</span><span class="kw">use </span>actix_web::{web, HttpResponse, Responder};
|
||
<span class="kw">use </span>serde::{Deserialize, Serialize};
|
||
|
||
<span class="kw">use crate</span>::{AppCtx, GIT_COMMIT_HASH, VERSION};
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Deserialize, Serialize)]
|
||
</span><span class="kw">pub struct </span>BuildDetails<<span class="lifetime">'a</span>> {
|
||
<span class="kw">pub </span>version: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="kw">pub </span>git_commit_hash: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
<span class="kw">pub </span>source_code: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
||
}
|
||
|
||
<span class="kw">pub mod </span>routes {
|
||
<span class="kw">pub struct </span>Meta {
|
||
<span class="kw">pub </span>build_details: <span class="kw-2">&</span><span class="lifetime">'static </span>str,
|
||
<span class="kw">pub </span>health: <span class="kw-2">&</span><span class="lifetime">'static </span>str,
|
||
}
|
||
|
||
<span class="kw">impl </span>Meta {
|
||
<span class="kw">pub const fn </span>new() -> <span class="self">Self </span>{
|
||
<span class="self">Self </span>{
|
||
build_details: <span class="string">"/api/v1/meta/build"</span>,
|
||
health: <span class="string">"/api/v1/meta/health"</span>,
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// emits build details of the binary
|
||
</span><span class="attribute">#[actix_web_codegen_const_routes::get(path = <span class="string">"crate::V1_API_ROUTES.meta.build_details"</span>)]
|
||
#[tracing::instrument(name = <span class="string">"Fetch Build Details"</span>, skip(ctx))]
|
||
</span><span class="kw">async fn </span>build_details(ctx: AppCtx) -> <span class="kw">impl </span>Responder {
|
||
<span class="kw">let </span>build = BuildDetails {
|
||
version: VERSION,
|
||
git_commit_hash: GIT_COMMIT_HASH,
|
||
source_code: <span class="kw-2">&</span>ctx.settings.source_code,
|
||
};
|
||
HttpResponse::Ok().json(build)
|
||
}
|
||
|
||
<span class="attribute">#[derive(Clone, Debug, Deserialize, Serialize)]
|
||
</span><span class="doccomment">/// Health check return datatype
|
||
</span><span class="kw">pub struct </span>Health {
|
||
db: bool,
|
||
}
|
||
|
||
<span class="doccomment">/// checks all components of the system
|
||
</span><span class="attribute">#[actix_web_codegen_const_routes::get(path = <span class="string">"crate::V1_API_ROUTES.meta.health"</span>)]
|
||
#[tracing::instrument(name = <span class="string">"Fetch health"</span>, skip(ctx))]
|
||
</span><span class="kw">async fn </span>health(ctx: <span class="kw">crate</span>::AppCtx) -> <span class="kw">impl </span>Responder {
|
||
<span class="kw">let </span>res = Health {
|
||
db: ctx.db.ping().<span class="kw">await</span>,
|
||
};
|
||
|
||
HttpResponse::Ok().json(res)
|
||
}
|
||
|
||
<span class="kw">pub fn </span>services(cfg: <span class="kw-2">&mut </span>web::ServiceConfig) {
|
||
cfg.service(build_details);
|
||
cfg.service(health);
|
||
}
|
||
|
||
<span class="attribute">#[cfg(test)]
|
||
</span><span class="kw">mod </span>tests {
|
||
<span class="kw">use </span>actix_web::{http::StatusCode, test};
|
||
|
||
<span class="kw">use crate</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="attribute">#[actix_rt::test]
|
||
</span><span class="kw">async fn </span>build_details_works() {
|
||
<span class="kw">let </span>(_dir, ctx) = tests::get_ctx().<span class="kw">await</span>;
|
||
<span class="macro">println!</span>(<span class="string">"[log] test configuration {:#?}"</span>, ctx.settings);
|
||
<span class="kw">let </span>app = <span class="macro">get_app!</span>(ctx).<span class="kw">await</span>;
|
||
|
||
<span class="kw">let </span>resp = <span class="macro">get_request!</span>(app, V1_API_ROUTES.meta.build_details);
|
||
<span class="macro">check_status!</span>(resp, StatusCode::OK);
|
||
}
|
||
|
||
<span class="attribute">#[actix_rt::test]
|
||
</span><span class="kw">async fn </span>health_works() {
|
||
<span class="kw">use </span>actix_web::test;
|
||
|
||
<span class="kw">let </span>(_dir, ctx) = tests::get_ctx().<span class="kw">await</span>;
|
||
<span class="kw">let </span>app = <span class="macro">get_app!</span>(ctx).<span class="kw">await</span>;
|
||
|
||
<span class="kw">let </span>resp = test::call_service(
|
||
<span class="kw-2">&</span>app,
|
||
test::TestRequest::get()
|
||
.uri(<span class="kw">crate</span>::V1_API_ROUTES.meta.health)
|
||
.to_request(),
|
||
)
|
||
.<span class="kw">await</span>;
|
||
<span class="macro">assert_eq!</span>(resp.status(), StatusCode::OK);
|
||
|
||
<span class="kw">let </span>health_resp: <span class="kw">super</span>::Health = test::read_body_json(resp).<span class="kw">await</span>;
|
||
<span class="macro">assert!</span>(health_resp.db);
|
||
}
|
||
}
|
||
</code></pre></div>
|
||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pages" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html> |