Skip to content
Snippets Groups Projects
Commit 586fef48 authored by Martin Lowe's avatar Martin Lowe :no_entry:
Browse files

Remove permissions docs as it was moved to a separate project

parent 983bb2fe
No related branches found
No related tags found
No related merge requests found
...@@ -148,32 +148,6 @@ The following parameters can be used when running the sync scripts manually. ...@@ -148,32 +148,6 @@ The following parameters can be used when running the sync scripts manually.
### Running the toolset for development ### Running the toolset for development
#### Testing the override JSON
As the override/exclusion list JSON takes a very particular format, a simple testing tool was introduced that will parse a file at a passed location and attempt to format it as specified in the class. To run this test, use the command `node src/scripts/UserPermissionsPretest.js -f "/the/absolute/file/path"`, replacing the value for the `-f` flag with the absolute file path. On a successful run, the script will log in the console the number of discovered entries in the file
```
❯ node src/scripts/UserPermissionsPretest.js -f $PWD/test/perms/test.json
Successfully parsed 3 overrides and 2 exclusions
```
On error, this script will indicate in the terminal the errors encountered while parsing from the validation package. This error in the console should indicate where the validation errors were with an explicit path and a message describing the issue. An example of this is the following console output, using one of the test files as an initial source:
```
❯ node src/scripts/UserPermissionsPretest.js -f $PWD/test/perms/invalid_format.json
Error encountered while processing JSON at /home/martin/localdev/eclipsefdn-webdev-toolkit/projects-js/eclipsefdn-github-sync/test/perms/invalid_format.json: [
{
"code": "invalid_date",
"path": [
"overrides",
1,
"expiry"
],
"message": "Invalid date"
}
]
```
#### Running for Github #### Running for Github
By default, the script is run in docker containers to emulate the production environment (Openshift). This sync tool can be run in standard and verbose mode. The difference between the modes is that in verbose all log messages are printed to the STDOUT of the container. By default, the script is run in docker containers to emulate the production environment (Openshift). This sync tool can be run in standard and verbose mode. The difference between the modes is that in verbose all log messages are printed to the STDOUT of the container.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment