Skip to content

Commit edab0c1

Browse files
committed
updated README
1 parent 80ba449 commit edab0c1

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ For operational installation of LDDTool, see the deployed documentation for inst
2626

2727

2828
### Development
29+
2930
For development installation, use maven:
3031

3132
```console
@@ -39,6 +40,34 @@ $ # To view generated docs
3940
$ open target/staging/model/index.html
4041
```
4142

43+
### Testing
44+
45+
Tests are ran using Cucumber and Maven.
46+
47+
#### Running Tests
48+
49+
```bash
50+
# Package the software
51+
mvn clean package
52+
53+
# Run Cucumber tests
54+
mvn clean test
55+
```
56+
57+
#### Adding New Tests
58+
59+
To add additional tests:
60+
61+
- Create a directory within the [resources](model-lddtool/src/test/resources) directory and place your test data there
62+
- In either the [developer](model-lddtool/src/test/resources/features/developer.feature) or [integration](model-lddtool/src/test/resources/features/integration.feature) feature file, add your test case to the table under `Examples`. For example,
63+
64+
```feature
65+
| testName | resourceDirectory | testDirectory | commandArgs | expectedResponse |
66+
| "NASA-PDS/pds4-information-model#738 LDDTool is not creating valid URL for KPLO" | "src/test/resources" | "github738" | "-lpJ {resourceDirectory}/{testDirectory}/PDS4_KPLO_IngestLDD.xml" | "0 error(s)" |
67+
```
68+
69+
### Update Site Documentation
70+
4271
To update the site documentation, see each components `src/site` directory (this is common for all Java Maven software):
4372
| Component | Site Directory | Online Documentation |
4473
|-----------|----------------|----------------------|
@@ -48,6 +77,7 @@ To update the site documentation, see each components `src/site` directory (this
4877
| Ontology | `model-ontology/src/site` | https://nasa-pds.github.io/pds4-information-model/model-ontology/ |
4978

5079
### Detect Secrets
80+
5181
The Planetary Data System's Engineering Node uses [detect-secrets](https://github.com/Yelp/detect-secrets), specifically a version forked by the [SLIM Team](https://nasa-ammos.github.io/slim/), called [slim-detect-secrets](https://github.com/NASA-AMMOS/slim-detect-secrets/tree/exp). This tool replaces Git Secrets but serves the same purpose: it helps prevent committing information to a repository that should remain secret. Unlike Git Secrets, though, the kinds of secrets detect-secrets finds includes not just passwords or API keys, but also hostnames and email addresses. It also uses entropy analysis to detect randomized strings that could be passwords.
5282

5383
To install, [see the wiki](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#detect-secrets). To update a new `.secrets.baseline` file, run the custom script in the repo to generate the secrets. https://github.com/NASA-PDS/pds4-information-model/tree/main/bin. This is needed because there are numerous additional files that should be ignored in this repo.

0 commit comments

Comments
 (0)