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

Jump to bottom

1635 plug in validator tools #2206

Merged
merged 50 commits into from
Jun 8, 2023
Merged

1635 plug in validator tools #2206

merged 50 commits into from
Jun 8, 2023

Conversation

HannahJMWood
Copy link
Contributor

No description provided.

HannahJMWood and others added 30 commits May 24, 2023 11:24
@HannahJMWood
added a function to validate plugin
e5f0055
@ollie-b-gds
initial checks for plugin and config
896b219
@ollie-b-gds
pulled logic for validate plugin out of cli file
08caed9
@ollie-b-gds
validating keys in config
2705cde
@ollie-b-gds
implmemented checking / at start of path
3c9740e
@ollie-b-gds
implemented validation of / in templates
9a74ac0
@ollie-b-gds
a few changes we didnt checkin
bcb0426
@HannahJMWood
fixing linting issues
cac8bb8
@HannahJMWood
removing comment, refactoring if statements
0a89775
@HannahJMWood
adding test file
f04d123
@HannahJMWood @ollie-b-gds
added errors array, worked on tests
83fc1ac 
Co-authored-by: Ollie Beumkes <ollie-b-gds@users.noreply.github.com>
@HannahJMWood
fixing linting issues
1b69177
@HannahJMWood
progress on tests
81f9193
@HannahJMWood
removing plugin name arg and its if checks
2a58c7f
@HannahJMWood
setting up file structure for testing
10941e9
@HannahJMWood
add configs to fake project, add test set up code
45c39ae
@HannahJMWood
addingd login for testing
a086337
@HannahJMWood
uncommenting some test code
8f290b6
@HannahJMWood
changing it back to exists
4ec50eb
@HannahJMWood
rename config files to standard naming convention
2fa1a59
@HannahJMWood
some async fixes & code simplification
96c7add
@BenSurgisonGDS
make testing easier
3fcad1e
@ollie-b-gds
replicated logic for invalid config
327e0b8
@ollie-b-gds
refactored testing for plugins validator
795aefb
@ollie-b-gds
refactored valid and invalid tests
947d566
@ollie-b-gds
fixed valid config tests
9c4382c
@ollie-b-gds
added new valid-plugin files
5b932b9
@ollie-b-gds
added config string checker
60606e4
@HannahJMWood
fixing linting issue
83fe0da
@HannahJMWood
adding error message to test for invalid plugin
621b7e1
@HannahJMWood
Copy link
Contributor Author

There's a couple TODOs that might need discussion. I'm also happy to refactor the else if logic in the validateConfigPaths() function to a switch statement if people think that might make it more readable.

@HannahJMWood HannahJMWood marked this pull request as ready for review June 7, 2023 10:13
BenSurgisonGDS
BenSurgisonGDS approved these changes Jun 8, 2023
View reviewed changes
Copy link
Contributor

@BenSurgisonGDS BenSurgisonGDS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ok so I'll approve, but I think we'll need to revisit the validator with a validator config solution to validate the plugins config.

lib/plugins/plugin-validator.js Outdated
keysToValidate.forEach(key => {
// Convert any strings to an array so that they can be processed
let criteriaConfig = pluginConfig[key]
if (typeof criteriaConfig === 'string') {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to instead check that criteriaConfig is not an Array as it could be something other than a string.

Instead use if (!Array.isArray(criteriaConfig) {

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@HannahJMWood HannahJMWood merged commit 59c3473 into main Jun 8, 2023
@HannahJMWood HannahJMWood deleted the 1635_plug-in_validator_tools branch June 8, 2023 15:48
@HannahJMWood HannahJMWood linked an issue Jun 9, 2023 that may be closed by this pull request
Tools to help plug-in authors test their plug-ins #1635
Closed
3 tasks
@ollie-b-gds ollie-b-gds mentioned this pull request Jun 20, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BenSurgisonGDS BenSurgisonGDS BenSurgisonGDS approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Tools to help plug-in authors test their plug-ins
3 participants
@HannahJMWood @BenSurgisonGDS @ollie-b-gds