oparlint-suites 0.0.2

Lint suites that can be run by oparlint
Documentation 
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

// SPDX-FileCopyrightText: Politik im Blick developers
// SPDX-FileCopyrightText: Wolfgang Silbermayr <wolfgang@silbermayr.at>
//
// SPDX-License-Identifier: AGPL-3.0-or-later OR EUPL-1.2

use oparlint_linting::{LintSuite, LintingResult};
use url::Url;

use crate::{
    Optionality,
    common::{
        fields::{
            BODY_FIELD_NAME, CONTACT_EMAIL_FIELD_NAME, EmailFieldSuite, LICENSE_FIELD_NAME,
            NAMESPACE_URL_SYSTEM, PRODUCT_FIELD_NAME, UrlFieldSuite, VENDOR_FIELD_NAME,
            WEB_FIELD_NAME, WEBSITE_FIELD_NAME,
        },
        requests::EntityRequestSuite,
    },
    system::{OParlVersionFieldSuite, OtherOParlVersionsSuite},
};

/// Lint suite to check an OParl System.
#[derive(Debug)]
pub struct SystemSuite<'a> {
    url: &'a Url,
}

impl<'a> SystemSuite<'a> {
    /// Create a new system lint suite.
    pub fn new(url: &'a Url) -> Self {
        Self { url }
    }
}

#[async_trait::async_trait]
impl<'a> LintSuite for SystemSuite<'a> {
    type Output = ();

    fn identifier(&self) -> String {
        "system".into()
    }

    fn title(&self) -> String {
        "Request to OParl system endpoint performs as expected".into()
    }

    async fn execute<L: oparlint_linting::Linter + Send>(self, linter: &mut L) -> LintingResult {
        let object = linter
            .execute_suite(EntityRequestSuite::new(self.url, NAMESPACE_URL_SYSTEM))
            .await?;

        _ = linter
            .execute_suite(OParlVersionFieldSuite::new(&object))
            .await;
        _ = linter
            .execute_suite(OtherOParlVersionsSuite::new(&object))
            .await;
        _ = linter
            .execute_suite(UrlFieldSuite::new(
                LICENSE_FIELD_NAME,
                Optionality::Optional,
                &object,
            ))
            .await;
        _ = linter
            .execute_suite(UrlFieldSuite::new(
                BODY_FIELD_NAME,
                Optionality::Required,
                &object,
            ))
            .await;
        _ = linter
            .execute_suite(UrlFieldSuite::new(
                WEBSITE_FIELD_NAME,
                Optionality::Optional,
                &object,
            ))
            .await;
        _ = linter
            .execute_suite(UrlFieldSuite::new(
                VENDOR_FIELD_NAME,
                Optionality::Optional,
                &object,
            ))
            .await;
        _ = linter
            .execute_suite(UrlFieldSuite::new(
                PRODUCT_FIELD_NAME,
                Optionality::Optional,
                &object,
            ))
            .await;
        _ = linter
            .execute_suite(EmailFieldSuite::new(
                CONTACT_EMAIL_FIELD_NAME,
                Optionality::Optional,
                &object,
            ))
            .await;
        _ = linter
            .execute_suite(UrlFieldSuite::new(
                WEB_FIELD_NAME,
                Optionality::Optional,
                &object,
            ))
            .await;

        Ok(())
    }
}