v3.1.0

[joshfried-aws]

What's Changed

• [Code Quality]: removing unecessary result return types by @joshfried-aws in [Code Quality]: removing unecessary result return types #445
• [Enhancement]: JUnit reporter for validate command by @joshfried-aws in [Enhancement]: JUnit reporter for validate command #446
• [Enhancement] Test Command enhanced reporters (JSON/YAML) by @joshfried-aws in [Enhancement] Test Command enhanced reporters (JSON/YAML) #447
• [Misc]: changing all walkdirs to use the same cmp operator by @joshfried-aws in [Misc]: changing all walkdirs to use the same cmp operator #450
• [Enhancement] Only show errors/failures in output by @dannyvassallo in [Enhancement] Only show errors/failures in output #448
• [Enhancement]: JUnit reporters for test command by @joshfried-aws in [Enhancement]: JUnit reporters for test command #451
• "[Misc]: updating readme to reflect new reporters for test and validate" by @joshfried-aws in "[Misc]: updating readme to reflect new reporters for test and validate" #452
• [Misc]: updating build and unit tests to include a windows job by @joshfried-aws in [Misc]: updating build and unit tests to include a windows job #449
• [Misc]: addressing new clippy lints in rust 1.76 by @joshfried-aws in [Misc]: addressing new clippy lints in rust 1.76 #454
• fix rulegen invalid parameter by @sejimhp in fix rulegen invalid parameter #453
• [Enhancement] Use pretty_assertions by @dannyvassallo in [Enhancement] Use pretty_assertions #456
• [Enhancement] Show full path to file [Enhancement] Show full path to file #410 by @dannyvassallo in [Enhancement] Show full path to file #410 #457
• [Enhancement]: cfn-guard as a library by @joshfried-aws in [Enhancement]: cfn-guard as a library  #458
• [Enhancement] Add support for windows by @dannyvassallo in [Enhancement] Add support for windows #460
• [Enhancement] Vscode workspace settings by @dannyvassallo in [Enhancement] Vscode workspace settings #462
• [Enhancement] Windows support - Powershell check gh action by @dannyvassallo in [Enhancement] Windows support - Powershell check gh action #463
• [Code Quality]: default implementation for reader and writer by @joshfried-aws in [Code Quality]: default implementation for reader and writer #461
• adding rustdocs for validate, and it's builder by @joshfried-aws in adding rustdocs for validate, and it's builder #465
• [Enhancement] Add typo checker and correct errors by @dannyvassallo in [Enhancement] Add typo checker and correct errors #464
• [Misc]: doc updates for test command by @joshfried-aws in [Misc]: doc updates for test command #467
• [MISC] docs update for parse-tree command by @joshfried-aws in [MISC] docs update for parse-tree command #468
• [Misc]: rulegen docs by @joshfried-aws in [Misc]: rulegen docs #469
• [Misc] Removing unnecessary public modifiers by @joshfried-aws in [Misc] Removing unnecessary public modifiers  #470
• [Enhancement] Add support for SARIF by @dannyvassallo in [Enhancement] Add support for SARIF #473
• [MISC]: bumping up versions for all packages to 3.1.0-beta by @joshfried-aws in [MISC]: bumping up versions for all packages to 3.1.0-beta #474
• Bump mio from 0.8.5 to 0.8.11 by @dependabot in Bump mio from 0.8.5 to 0.8.11 #477
• [Documentation] Add ci examples by @dannyvassallo in [Documentation] Add ci examples #481
• [BugFix]: Addressing issues with parsing newline characters on windows for conjunctions by @joshfried-aws in [BugFix]: Addressing issues with parsing newline characters on windows for conjunctions  #482
• [Documentation] SARIF Example by @dannyvassallo in [Documentation] SARIF Example #483
• [Documentation] Use Docker for JUNIT examples by @dannyvassallo in [Documentation] Use Docker for JUNIT examples #484
• [Docs] Adding documentation for all converter functions by @joshfried-aws in [Docs] Adding documentation for all converter functions #486
• [Docs] Providing an example for the validate command by @joshfried-aws in [Docs] Providing an example for the validate command  #487
• [Misc]: updating all references of 3.1.0-beta to 3.1.0 by @joshfried-aws in [Misc]: updating all references of 3.1.0-beta to 3.1.0 #488

New Contributors

• @dannyvassallo made their first contribution in [Enhancement] Only show errors/failures in output #448
• @sejimhp made their first contribution in fix rulegen invalid parameter #453

Full Changelog: 3.0.3...3.1.0

Table of Contents

1. New Validate reporters
2. New Test Flag to Specify an Output
3. Cfn-Guard as a Library
4. Stabilized Converter Functions

New Validate Reporters

1. JUnit - users can now use the -o or --output-format flag to request a JUnit report -o junit
2. Sarif - users can now use the -o or --output-format flag to request a Sarif report -o sarif

NOTE: If either junit, or sarif output-format is set, this requires the user to also pass --structured, and -S none otherwise cfn-guard will return an error

New Test Flag to Specify an Output

1. The output format flag has been added to the test command. This means users can now take advantage of 4 different reporting mechanisms; single-line-summary, json, yaml, or junit

Cfn-Guard as a Library

1. Users can now leverage cfn-guard as a library. We now have added builders for users to construct commands, and call them as needed. This will allow users to more easily build solutions with cfn-guard for specific needs

Stabilized Converter Functions

NOTE: This feature was previously introduced in version 3.0.1, it is now stabilized as of version 3.1.0
To improve the user experience for validating templates when schemas use types that might be easier evaluated as a different type (i.e. a string thats actually a number) the 3.0.1 release adds support to convert between specific types.

The conversions allowed are the following
strings/floats-> ints
strings/ints -> floats
strings -> bools
bools/floats/ints -> strings

The following is an example of parsing a string into an int.

Given the following template:

Resources:
  asg:
    Type: AWS::AutoScaling::AutoScalingGroup
    Properties:
      MinSize: "1"

We can write the following rule

let asg = Resources.*[ Type == 'AWS::AutoScaling::AutoScalingGroup' ]

rule test_parse_int when %asg !empty {
   let min = parse_int(%asg.Properties.MinSize)

   %min == 1
}

---

This discussion was created from the release v3.1.0.