Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add validation of resource output #362

Merged
merged 4 commits into from
Mar 22, 2024
Merged

Add validation of resource output #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
06a27e2
Add validation of resource output
SteveL-MSFT Mar 9, 2024
f3f20c7
address Andrew's feedback adding verification of export output json
Mar 13, 2024
72df61d
fix clippy
Mar 13, 2024
556379e
Merge branch 'main' into output-validation
SteveL-MSFT Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion dsc_lib/src/dscresources/command_resource.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use serde_json::Value;
use std::{collections::HashMap, env, process::Command, io::{Write, Read}, process::Stdio};
use crate::{dscerror::DscError, dscresources::invoke_result::{ResourceGetResponse, ResourceSetResponse, ResourceTestResponse}};
use crate::configure::config_result::ResourceGetResult;
use super::{dscresource::get_diff,resource_manifest::{ResourceManifest, InputKind, ReturnKind, SchemaKind}, invoke_result::{GetResult, SetResult, TestResult, ValidateResult, ExportResult}};
use super::{dscresource::get_diff,resource_manifest::{Kind, ResourceManifest, InputKind, ReturnKind, SchemaKind}, invoke_result::{GetResult, SetResult, TestResult, ValidateResult, ExportResult}};
use tracing::{error, warn, info, debug, trace};

pub const EXIT_PROCESS_TERMINATED: i32 = 0x102;
Expand Down Expand Up @@ -78,6 +78,11 @@ pub fn invoke_get(resource: &ResourceManifest, cwd: &str, filter: &str) -> Resul
return Err(DscError::Command(resource.resource_type.clone(), exit_code, stderr));
}

if resource.kind == Some(Kind::Resource) {
debug!("Verifying output of get '{}' using '{}'", &resource.resource_type, &resource.get.executable);
verify_json(resource, cwd, &stdout)?;
}

let result: GetResult = if let Ok(group_response) = serde_json::from_str::<Vec<ResourceGetResult>>(&stdout) {
trace!("Group get response: {:?}", &group_response);
GetResult::Group(group_response)
Expand Down Expand Up @@ -179,6 +184,11 @@ pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_te
return Err(DscError::Command(resource.resource_type.clone(), exit_code, stderr));
}

if resource.kind == Some(Kind::Resource) {
debug!("Verifying output of get '{}' using '{}'", &resource.resource_type, &resource.get.executable);
verify_json(resource, cwd, &stdout)?;
}

let pre_state: Value = if exit_code == 0 {
serde_json::from_str(&stdout)?
}
Expand All @@ -192,9 +202,15 @@ pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_te
if exit_code != 0 {
return Err(DscError::Command(resource.resource_type.clone(), exit_code, stderr));
}

match set.returns {
Some(ReturnKind::State) => {

if resource.kind == Some(Kind::Resource) {
debug!("Verifying output of set '{}' using '{}'", &resource.resource_type, &set.executable);
verify_json(resource, cwd, &stdout)?;
}

let actual_value: Value = match serde_json::from_str(&stdout){
Result::Ok(r) => {r},
Result::Err(err) => {
Expand Down Expand Up @@ -293,6 +309,11 @@ pub fn invoke_test(resource: &ResourceManifest, cwd: &str, expected: &str) -> Re
return Err(DscError::Command(resource.resource_type.clone(), exit_code, stderr));
}

if resource.kind == Some(Kind::Resource) {
debug!("Verifying output of test '{}' using '{}'", &resource.resource_type, &test.executable);
SteveL-MSFT marked this conversation as resolved.
Show resolved Hide resolved
verify_json(resource, cwd, &stdout)?;
}

let expected_value: Value = serde_json::from_str(expected)?;
match test.returns {
Some(ReturnKind::State) => {
Expand Down Expand Up @@ -462,6 +483,10 @@ pub fn invoke_export(resource: &ResourceManifest, cwd: &str, input: Option<&str>
return Err(DscError::Operation(format!("Failed to parse json from export {}|{}|{} -> {err}", &export.executable, stdout, stderr)))
}
};
if resource.kind == Some(Kind::Resource) {
debug!("Verifying output of export '{}' using '{}'", &resource.resource_type, &resource.get.executable);
verify_json(resource, cwd, line)?;
}
instances.push(instance);
}

Expand Down
52 changes: 0 additions & 52 deletions dsc_lib/src/dscresources/dscresource.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;
use tracing::{debug, trace};

use super::{command_resource, dscerror, invoke_result::{ExportResult, GetResult, ResourceTestResponse, SetResult, TestResult, ValidateResult}, resource_manifest::import_manifest};

Expand Down Expand Up @@ -77,54 +76,6 @@ impl DscResource {
manifest: None,
}
}

fn validate_input(&self, input: &str) -> Result<(), DscError> {
debug!("Validating input for resource: {}", &self.type_name);
if input.is_empty() {
return Ok(());
}
let Some(manifest) = &self.manifest else {
return Err(DscError::MissingManifest(self.type_name.clone()));
};
let resource_manifest = import_manifest(manifest.clone())?;

if resource_manifest.validate.is_some() {
trace!("Using custom validation");
let validation_result = match self.validate(input) {
Ok(validation_result) => validation_result,
Err(err) => {
return Err(DscError::Validation(format!("Validation failed: {err}")));
},
};
trace!("Validation result is valid: {}", validation_result.valid);
if !validation_result.valid {
return Err(DscError::Validation("Validation failed".to_string()));
}
}
else {
trace!("Using JSON schema validation");
let Ok(schema) = self.schema() else {
return Err(DscError::Validation("Schema not available".to_string()));
};

let schema = serde_json::from_str::<Value>(&schema)?;

let Ok(compiled_schema) = jsonschema::JSONSchema::compile(&schema) else {
return Err(DscError::Validation("Schema compilation failed".to_string()));
};

let input = serde_json::from_str::<Value>(input)?;
if let Err(err) = compiled_schema.validate(&input) {
let mut error = format!("Resource '{}' failed validation: ", self.type_name);
for e in err {
error.push_str(&format!("\n{e} "));
}
return Err(DscError::Validation(error));
};
}

Ok(())
}
}

impl Default for DscResource {
Expand Down Expand Up @@ -201,7 +152,6 @@ pub trait Invoke {

impl Invoke for DscResource {
fn get(&self, filter: &str) -> Result<GetResult, DscError> {
self.validate_input(filter)?;
match &self.implemented_as {
ImplementedAs::Custom(_custom) => {
Err(DscError::NotImplemented("get custom resources".to_string()))
Expand All @@ -217,7 +167,6 @@ impl Invoke for DscResource {
}

fn set(&self, desired: &str, skip_test: bool) -> Result<SetResult, DscError> {
self.validate_input(desired)?;
match &self.implemented_as {
ImplementedAs::Custom(_custom) => {
Err(DscError::NotImplemented("set custom resources".to_string()))
Expand All @@ -233,7 +182,6 @@ impl Invoke for DscResource {
}

fn test(&self, expected: &str) -> Result<TestResult, DscError> {
self.validate_input(expected)?;
match &self.implemented_as {
ImplementedAs::Custom(_custom) => {
Err(DscError::NotImplemented("test custom resources".to_string()))
Expand Down
Loading