Skip to content

introduction_to_repository.md

Latest commit

 

History

History
47 lines (25 loc) · 2.26 KB

introduction_to_repository.md

File metadata and controls

47 lines (25 loc) · 2.26 KB
Raw

Introduction to the Repository

This document aims to provide a introduction to the repository and its structure to new contributors and developers.

Repository structure

  • The main codebase for the DSS is in /pkg and /cmds, the core organization and structure of the DSS is in these directories.
  • The /interfaces folder contains diagrams, API specifications of the standards and other test tools that come with the DSS. This folder contains references to the ASTM standard, diagrams about remote-id test suite etc.

Documentation

Documentation is located in /docs and build automatically on each release.

To test documentation locally, you can use the following command:

make local-doc

and point your browser to http://127.0.0.1:8888/dss/

Live reload is enabled, you should be able to edit files locally and see changes in live.

The documentation uses generated assets from Graphviz and PlantUML.

You may generate them automatically using:

make doc-assets

Ensure dot is installed as dot and PlantUMl is installed as plantuml (if needed, create an alias to java -jar plantuml.jar, with the full jar path).

On Linux, you may automatically watch for changes and rebuild them on the fly with:

make dos-assets-watch

You need to have inotifywait installed for the command to work, usually via the inotify-tools package of your distribution.

Introduction to the Monitoring toolset

The monitoring repository contains a set of folders containing different test suites to test different capabilities of the DSS during development and production use.

Prober

  • The first and largest monitoring tool is the "prober" which is a full integration test of the DSS. This tool is used during continuous integration for the DSS.

USS Qualifier

The Prober is slowly being superseded by the USS qualifier: it provides extensive test coverage for the features of a DSS deployment via the DSS Probing configuration.