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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

use std::{collections::HashMap, io};

use findshlibs::{SharedLibrary, TargetSharedLibrary};
use serde::Serialize;

/// tskit's provenance JSON schema format root for version 1.0.0
#[allow(clippy::module_name_repetitions)]
#[derive(Serialize)]
pub struct TskitProvenance {
    schema_version: String,
    software: TskitProvenanceSoftware,
    parameters: TskitProvenanceParameters,
    environment: TskitProvenanceEnvironment,
}

impl TskitProvenance {
    pub fn try_new() -> io::Result<Self> {
        Ok(Self {
            schema_version: "1.0.0".to_owned(),
            software: TskitProvenanceSoftware::try_new()?,
            parameters: TskitProvenanceParameters::new(),
            environment: TskitProvenanceEnvironment::try_new()?,
        })
    }
}

#[derive(Serialize)]
struct TskitProvenanceSoftware {
    name: String,
    version: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    commit: Option<String>,
}

impl TskitProvenanceSoftware {
    pub fn try_new() -> io::Result<Self> {
        let executable = std::env::current_exe()?.canonicalize()?;

        let output = std::process::Command::new(&executable).arg("-V").output()?;

        let version_str = String::from_utf8_lossy(&output.stdout);
        let mut version = version_str.split_whitespace();

        // Split a version string such as 'man 2.9.1' into 'man' and '2.9.1'
        Ok(Self {
            name: version
                .next()
                .map_or_else(|| executable.to_string_lossy().into_owned(), str::to_owned),
            version: version
                .next()
                .map_or_else(|| "???".to_owned(), str::to_owned),
            commit: match git_version::git_version!(fallback = "unknown") {
                "unknown" => None,
                version => Some(version.to_owned()),
            },
        })
    }
}

#[derive(Serialize)]
struct TskitProvenanceParameters {
    args: Vec<String>,
}

impl TskitProvenanceParameters {
    pub fn new() -> Self {
        Self {
            args: std::env::args().collect(),
        }
    }
}

#[derive(Serialize)]
struct TskitProvenanceEnvironment {
    os: TskitProvenanceEnvironmentOs,
    #[allow(clippy::zero_sized_map_values)]
    libraries: HashMap<String, TskitProvenanceEnvironmentLibrary>,
    #[serde(with = "self::rustc_version::VersionMetaDef")]
    rustc: ::rustc_version::VersionMeta,
}

impl TskitProvenanceEnvironment {
    pub fn try_new() -> io::Result<Self> {
        #[allow(clippy::zero_sized_map_values)]
        let mut libraries = HashMap::new();

        // Create a map of all dynamically loaded libraries
        TargetSharedLibrary::each(|lib| {
            if let Ok(library) = TskitProvenanceEnvironmentLibrary::try_new(lib.name()) {
                libraries.insert(lib.name().to_string_lossy().into_owned(), library);
            }
        });

        Ok(Self {
            os: TskitProvenanceEnvironmentOs::try_new()?,
            libraries,
            rustc: rustc_version::version_meta(),
        })
    }
}

#[derive(Serialize)]
struct TskitProvenanceEnvironmentOs {
    system: String,
    node: String,
    release: String,
    version: String,
    machine: String,
}

impl TskitProvenanceEnvironmentOs {
    pub fn try_new() -> io::Result<Self> {
        let uname = uname::uname()?;

        Ok(Self {
            system: uname.sysname,
            node: uname.nodename,
            release: uname.release,
            version: uname.version,
            machine: uname.machine,
        })
    }
}

#[derive(Serialize)]
struct TskitProvenanceEnvironmentLibrary {}

impl TskitProvenanceEnvironmentLibrary {
    #[allow(clippy::unnecessary_wraps)]
    pub fn try_new(_library: &std::ffi::OsStr) -> io::Result<Self> {
        // TODO: Future work might deduce version information etc.

        Ok(Self {})
    }
}

mod rustc_version {
    include!(concat!(env!("OUT_DIR"), "/rustc_version.rs"));

    #[derive(serde::Serialize)]
    #[serde(remote = "rustc_version::VersionMeta")]
    pub(super) struct VersionMetaDef {
        pub semver: Version,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub commit_hash: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub commit_date: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub build_date: Option<String>,
        #[serde(serialize_with = "serialize_channel")]
        pub channel: Channel,
        pub host: String,
        pub short_version_string: String,
        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(serialize_with = "serialize_llvm_version")]
        pub llvm_version: Option<LlvmVersion>,
    }

    #[allow(clippy::trivially_copy_pass_by_ref)]
    fn serialize_channel<S: serde::Serializer>(
        channel: &Channel,
        serializer: S,
    ) -> Result<S::Ok, S::Error> {
        serializer.collect_str(&format!("{channel:?}"))
    }

    fn serialize_llvm_version<S: serde::Serializer>(
        llvm_version: &Option<LlvmVersion>,
        serializer: S,
    ) -> Result<S::Ok, S::Error> {
        #[allow(clippy::option_if_let_else)]
        if let Some(llvm_version) = llvm_version {
            serializer.collect_str(llvm_version)
        } else {
            serializer.serialize_none()
        }
    }
}