Converting site/profile to a PDK compatible module and automated validation
#424
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* updating ruby-version in Puppet validation action * fixed two lines that were stopping the execution of `pdk validate` * all files that are added or modified by `>pdk convert` at root all files that are added by `>pdk convert` at root files modified by `>pdk convert` at root * Revert "all files that are added or modified by `>pdk convert` at root" This reverts commit ce51ab3. * all files that are added by `>pdk convert` at `site/profile/` * adding basic workflow for puppet validation and unit testing, adding files/ to ignore field in `pdk/yaml`
* enhance PDK workflow with validation results annotation * switch to inline command for run property in pdk_tests.yaml * replacing shell script by python script to parse xml formatted result of `pdk validate` * setting up pdk manually, rather than having to install python in container * piping the output of `pdk validate` to pdk-validate annotation script * using job environment variable to define directory targeted by scan
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Warning
There is still some clean up to do regarding unnecessary files that have been generated from the conversion, such as CHANGELOG and README.
Some testing would be required as well to make sure the addition of new GemFile, RakeFile and such doesn't interfere with the ones outside of the module.
Conversion
This integrates PDK by converting the
site/profilemodule withpdk convert, following a given template.Here's a list of files that are targeted by
pdk convert.Validation and testing
PDK compatible modules can be validated and tested with
pdk validateandpdk test.A workflow has been introduced to trigger both validation and testing followed by the creation of annotations that will show directly in the Files changed tab of future PRs.
Note
Currently, site/profile has not yet defined unit tests. Basic unit tests can be generated by
pdk convert --add-tests, but most are failing. This will be the object of a future PR. For now, the workflow will simply declare that no tests were found and succeed anyway.