use std::collections::{BTreeMap, BTreeSet};
use serde::{Deserialize, Serialize};
use crate::diagnostics::{DiagnosticPath, DiagnosticSource};
use super::{ExecutionEngine, ExecutionMode, SourceLocation, SourceSpan, TargetReference};
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Fingerprint {
pub algorithm: String,
pub value: String,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Provenance {
pub activity: ProvenanceActivity,
pub source: Option<DiagnosticSource>,
pub span: Option<SourceSpan>,
pub tools: BTreeMap<String, String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "kind", rename_all = "kebab-case", deny_unknown_fields)]
pub enum ProvenanceActivity {
PythonRuntime {
target: TargetReference,
policy: String,
python_version: String,
sphinx_version: String,
docutils_version: String,
package_version: String,
dependencies: BTreeMap<String, String>,
inputs: Vec<InputFingerprint>,
},
DocumenterExamples {
collection: String,
policy: String,
julia_version: String,
dependencies: BTreeMap<String, String>,
project: InputFingerprint,
environment_inputs: Vec<InputFingerprint>,
input: InputFingerprint,
examples: Vec<DocumenterExampleOutcome>,
},
RustDoctests {
target: TargetReference,
policy: String,
package_name: String,
package_version: String,
compiler_version: String,
dependencies: BTreeMap<String, String>,
features: Vec<String>,
host: String,
inputs: Vec<InputFingerprint>,
examples: Vec<RustDoctestOutcome>,
},
ApiExamples {
package: String,
language: String,
policy: String,
runtime_version: String,
package_name: String,
package_version: String,
dependencies: BTreeMap<String, String>,
input: InputFingerprint,
examples: Vec<ApiExampleOutcome>,
},
JuliaRuntime {
target: TargetReference,
policy: String,
julia_version: String,
package_name: String,
package_uuid: String,
package_version: String,
dependencies: BTreeMap<String, String>,
},
RDocumentation {
package: String,
policy: String,
r_version: String,
roxygen2_version: String,
loader: String,
roclets: Vec<String>,
dependencies: BTreeMap<String, String>,
inputs: Vec<InputFingerprint>,
outputs: Vec<InputFingerprint>,
},
RRuntime {
package: String,
policy: String,
r_version: String,
package_version: String,
dependencies: BTreeMap<String, String>,
inputs: Vec<InputFingerprint>,
},
RMarkdown {
package: String,
policy: String,
r_version: String,
knitr_version: String,
package_version: String,
dependencies: BTreeMap<String, String>,
input: InputFingerprint,
output: Fingerprint,
chunks: Vec<RMarkdownChunkOutcome>,
inline: Vec<RMarkdownInlineOutcome>,
},
Declaration,
DecodedDocumentation {
decoded_span: SourceSpan,
},
GeneratedMarkdown {
collection: String,
cell: usize,
output: usize,
},
Extraction {
target: TargetReference,
mode: ExtractionMode,
capabilities: BTreeSet<String>,
parsers: BTreeMap<String, ParserProvenance>,
inputs: BTreeMap<String, BTreeMap<DiagnosticPath, ExtractionInput>>,
},
PackageMetadata {
package: String,
r_version: String,
policy: String,
inputs: Vec<InputFingerprint>,
},
RdExamples {
package: String,
policy: String,
r_version: String,
package_version: String,
dependencies: BTreeMap<String, String>,
input: InputFingerprint,
executed: Vec<String>,
illustrative: Vec<String>,
skipped: Vec<String>,
},
Execution {
mode: ExecutionMode,
engine: ExecutionEngine,
kernel: KernelProvenance,
origin: ExecutionOrigin,
declared_environment_inputs: Vec<InputFingerprint>,
},
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct DocumenterExampleOutcome {
pub span: SourceSpan,
pub session: Option<String>,
pub outputs: Vec<DocumenterOutput>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "kebab-case", deny_unknown_fields)]
pub enum DocumenterOutput {
Text {
text: String,
},
Image {
media_type: String,
asset: super::AssetReference,
},
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ApiExampleOutcome {
pub span: SourceSpan,
pub source: String,
pub expected: String,
pub actual: String,
pub outcome: String,
pub reason: Option<String>,
pub options: BTreeMap<String, String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RMarkdownChunkOutcome {
pub span: SourceSpan,
pub label: String,
pub options: BTreeMap<String, String>,
pub outcome: String,
pub reason: Option<String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RMarkdownInlineOutcome {
pub span: SourceSpan,
pub value: String,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum ExtractionMode {
Static,
Compiler,
Native,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RustDoctestOutcome {
pub name: String,
pub source: Option<SourceLocation>,
pub line: usize,
pub code: String,
pub attributes: BTreeMap<String, String>,
pub outcome: RustDoctestStatus,
pub output: String,
pub reason: Option<String>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum RustDoctestStatus {
Executed,
CompileOnly,
ExpectedError,
ExplicitSkip,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ParserProvenance {
pub version: String,
pub role: String,
pub settings: BTreeMap<String, String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ExtractionInput {
pub kind: String,
pub fingerprint: Fingerprint,
pub parsers: BTreeSet<String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct SourceEvidence {
pub source: SourceLocation,
pub role: SourceRole,
pub parsers: BTreeSet<String>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum SourceRole {
Metadata,
Export,
Registration,
Definition,
Signature,
Documentation,
Diagnostic,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct InputFingerprint {
pub source: SourceLocation,
pub fingerprint: Fingerprint,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct KernelProvenance {
pub name: String,
pub language: Option<String>,
pub language_version: Option<String>,
pub version: Option<String>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum ExecutionOrigin {
Executed,
Cache,
}