crates/shirabe/src/repository/advisory_provider_interface.rs


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

//! ref: composer/src/Composer/Repository/AdvisoryProviderInterface.php

use crate::advisory::PartialSecurityAdvisory;
use crate::advisory::SecurityAdvisory;
use indexmap::IndexMap;
use shirabe_semver::constraint::AnyConstraint;

#[derive(Debug)]
pub enum PartialOrSecurityAdvisory {
    Partial(PartialSecurityAdvisory),
    Full(SecurityAdvisory),
}

impl PartialOrSecurityAdvisory {
    pub fn advisory_id(&self) -> &str {
        match self {
            PartialOrSecurityAdvisory::Partial(p) => &p.advisory_id,
            PartialOrSecurityAdvisory::Full(s) => s.advisory_id(),
        }
    }
}

#[derive(Debug)]
pub struct SecurityAdvisoryResult {
    pub names_found: Vec<String>,
    pub advisories: IndexMap<String, Vec<PartialOrSecurityAdvisory>>,
}

pub trait AdvisoryProviderInterface {
    fn has_security_advisories(&self) -> bool;

    fn get_security_advisories(
        &self,
        package_constraint_map: IndexMap<String, AnyConstraint>,
        allow_partial_advisories: bool,
    ) -> anyhow::Result<SecurityAdvisoryResult>;
}