[Enhancement] Test Command enhanced reporters (JSON/YAML)

guard/resources/test-command/output-dir/structured_directory_report_json.out

@@ -0,0 +1,133 @@
+[
+  {
+    "rule_file": "resources/test-command/dir/s3_bucket_logging_enabled.guard",
+    "test_cases": [
+      {
+        "name": "Empty, SKIP",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_LOGGING_ENABLED",
+            "evaluated": "SKIP"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "No resources, SKIP",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_LOGGING_ENABLED",
+            "evaluated": "SKIP"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "S3 Bucket with Logging Configuration present in resource, PASS",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_LOGGING_ENABLED",
+            "evaluated": "PASS"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "S3 Bucket with Logging Configuration missing, FAIL",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_LOGGING_ENABLED",
+            "evaluated": "FAIL"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "S3 Bucket with Logging Configuration missing with suppression, SKIP",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_LOGGING_ENABLED",
+            "evaluated": "SKIP"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      }
+    ]
+  },
+  {
+    "rule_file": "resources/test-command/dir/s3_bucket_server_side_encryption_enabled.guard",
+    "test_cases": [
+      {
+        "name": "Empty, SKIP",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+            "evaluated": "SKIP"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "No resources, SKIP",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+            "evaluated": "SKIP"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "S3 Bucket Encryption set to SSE AES 256, PASS",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+            "evaluated": "PASS"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "S3 Bucket Encryption set to SSE AWS KMS key, PASS",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+            "evaluated": "PASS"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "S3 Bucket Encryption not set, FAIL",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+            "evaluated": "FAIL"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      },
+      {
+        "name": "S3 Bucket Encryption not set but rule is suppressed, SKIP",
+        "passed_rules": [
+          {
+            "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+            "evaluated": "SKIP"
+          }
+        ],
+        "failed_rules": [],
+        "skipped_rules": []
+      }
+    ]
+  }
+]

guard/resources/test-command/output-dir/structured_directory_report_yaml.out

@@ -0,0 +1,70 @@
+- rule_file: resources/test-command/dir/s3_bucket_logging_enabled.guard
+  test_cases:
+  - name: Empty, SKIP
+    passed_rules:
+    - name: S3_BUCKET_LOGGING_ENABLED
+      evaluated: SKIP
+    failed_rules: []
+    skipped_rules: []
+  - name: No resources, SKIP
+    passed_rules:
+    - name: S3_BUCKET_LOGGING_ENABLED
+      evaluated: SKIP
+    failed_rules: []
+    skipped_rules: []
+  - name: S3 Bucket with Logging Configuration present in resource, PASS
+    passed_rules:
+    - name: S3_BUCKET_LOGGING_ENABLED
+      evaluated: PASS
+    failed_rules: []
+    skipped_rules: []
+  - name: S3 Bucket with Logging Configuration missing, FAIL
+    passed_rules:
+    - name: S3_BUCKET_LOGGING_ENABLED
+      evaluated: FAIL
+    failed_rules: []
+    skipped_rules: []
+  - name: S3 Bucket with Logging Configuration missing with suppression, SKIP
+    passed_rules:
+    - name: S3_BUCKET_LOGGING_ENABLED
+      evaluated: SKIP
+    failed_rules: []
+    skipped_rules: []
+- rule_file: resources/test-command/dir/s3_bucket_server_side_encryption_enabled.guard
+  test_cases:
+  - name: Empty, SKIP
+    passed_rules:
+    - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+      evaluated: SKIP
+    failed_rules: []
+    skipped_rules: []
+  - name: No resources, SKIP
+    passed_rules:
+    - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+      evaluated: SKIP
+    failed_rules: []
+    skipped_rules: []
+  - name: S3 Bucket Encryption set to SSE AES 256, PASS
+    passed_rules:
+    - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+      evaluated: PASS
+    failed_rules: []
+    skipped_rules: []
+  - name: S3 Bucket Encryption set to SSE AWS KMS key, PASS
+    passed_rules:
+    - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+      evaluated: PASS
+    failed_rules: []
+    skipped_rules: []
+  - name: S3 Bucket Encryption not set, FAIL
+    passed_rules:
+    - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+      evaluated: FAIL
+    failed_rules: []
+    skipped_rules: []
+  - name: S3 Bucket Encryption not set but rule is suppressed, SKIP
+    passed_rules:
+    - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+      evaluated: SKIP
+    failed_rules: []
+    skipped_rules: []

guard/resources/test-command/output-dir/structured_single_report_json.out

@@ -0,0 +1,71 @@
+{
+  "rule_file": "resources/validate/rules-dir/s3_bucket_server_side_encryption_enabled.guard",
+  "test_cases": [
+    {
+      "name": "Empty, SKIP",
+      "passed_rules": [
+        {
+          "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+          "evaluated": "SKIP"
+        }
+      ],
+      "failed_rules": [],
+      "skipped_rules": []
+    },
+    {
+      "name": "No resources, SKIP",
+      "passed_rules": [
+        {
+          "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+          "evaluated": "SKIP"
+        }
+      ],
+      "failed_rules": [],
+      "skipped_rules": []
+    },
+    {
+      "name": "S3 Bucket Encryption set to SSE AES 256, PASS",
+      "passed_rules": [
+        {
+          "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+          "evaluated": "PASS"
+        }
+      ],
+      "failed_rules": [],
+      "skipped_rules": []
+    },
+    {
+      "name": "S3 Bucket Encryption set to SSE AWS KMS key, PASS",
+      "passed_rules": [
+        {
+          "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+          "evaluated": "PASS"
+        }
+      ],
+      "failed_rules": [],
+      "skipped_rules": []
+    },
+    {
+      "name": "S3 Bucket Encryption not set, FAIL",
+      "passed_rules": [
+        {
+          "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+          "evaluated": "FAIL"
+        }
+      ],
+      "failed_rules": [],
+      "skipped_rules": []
+    },
+    {
+      "name": "S3 Bucket Encryption not set but rule is suppressed, SKIP",
+      "passed_rules": [
+        {
+          "name": "S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED",
+          "evaluated": "SKIP"
+        }
+      ],
+      "failed_rules": [],
+      "skipped_rules": []
+    }
+  ]
+}

guard/resources/test-command/output-dir/structured_single_report_yaml.out

@@ -0,0 +1,38 @@
+rule_file: resources/validate/rules-dir/s3_bucket_server_side_encryption_enabled.guard
+test_cases:
+- name: Empty, SKIP
+  passed_rules:
+  - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+    evaluated: SKIP
+  failed_rules: []
+  skipped_rules: []
+- name: No resources, SKIP
+  passed_rules:
+  - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+    evaluated: SKIP
+  failed_rules: []
+  skipped_rules: []
+- name: S3 Bucket Encryption set to SSE AES 256, PASS
+  passed_rules:
+  - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+    evaluated: PASS
+  failed_rules: []
+  skipped_rules: []
+- name: S3 Bucket Encryption set to SSE AWS KMS key, PASS
+  passed_rules:
+  - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+    evaluated: PASS
+  failed_rules: []
+  skipped_rules: []
+- name: S3 Bucket Encryption not set, FAIL
+  passed_rules:
+  - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+    evaluated: FAIL
+  failed_rules: []
+  skipped_rules: []
+- name: S3 Bucket Encryption not set but rule is suppressed, SKIP
+  passed_rules:
+  - name: S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED
+    evaluated: SKIP
+  failed_rules: []
+  skipped_rules: []

guard/resources/validate/malformed-rule.guard

@@ -1,10 +1,8 @@
-
-
 rule S3_BUCKET_SERVER_SIDE_ENCRYPTION_ENABLED_2 when %s3_buckets_server_side_encryption_2 !empty {
   %s3_buckets_server_side_encryption_2.Properties.BucketEncryption exists
   %s3_buckets_server_side_encryption_2.Properties.BucketEncryption.ServerSideEncryptionConfiguration[*].ServerSideEncryptionByDefault.SSEAlgorithm in ["aws:kms","AES256"]
   <<
     Violation: S3 Bucket must enable server-side encryption #2.
     Fix: Set the S3 Bucket property #2 BucketEncryption.ServerSideEncryptionConfiguration.ServerSideEncryptionByDefault.SSEAlgorithm to either "aws:kms" or "AES256"
   >>
-}
+}

guard/src/commands/files.rs

@@ -6,7 +6,7 @@ use std::path::PathBuf;
 use crate::rules::errors::Error;
 use walkdir::WalkDir;
 
-pub(crate) fn read_file_content(file: File) -> Result<String, std::io::Error> {
+pub(crate) fn read_file_content(file: File) -> crate::rules::Result<String> {
     let mut file_content = String::new();
     let mut buf_reader = BufReader::new(file);
     buf_reader.read_to_string(&mut file_content)?;
@@ -62,7 +62,7 @@ where
         };
         let content = match read_file_content(file) {
             Ok(content) => content,
-            Err(e) => return Some(Err(Error::from(e))),
+            Err(e) => return Some(Err(e)),
         };
         Some((self.converter)(content, next))
     }

guard/src/commands/mod.rs

@@ -3,6 +3,7 @@ pub(crate) mod helper;
 pub mod parse_tree;
 pub mod rulegen;
 pub mod test;
+pub(crate) mod test_reporters;
 pub mod validate;
 
 mod aws_meta_appender;
@@ -59,3 +60,5 @@ pub(crate) const RULE_FILE_SUPPORTED_EXTENSIONS: [&str; 2] = [".guard", ".rulese
 pub const FAILURE_STATUS_CODE: i32 = 19;
 pub const SUCCESS_STATUS_CODE: i32 = 0;
 pub const ERROR_STATUS_CODE: i32 = 5;
+pub const TEST_ERROR_STATUS_CODE: i32 = 1;
+pub const TEST_FAILURE_STATUS_CODE: i32 = 7;