saml-test-spec-editor

This package adds lookup for SAML test specification editing to autocomplete+ suggestions.

Description

This package helps with editing SAML test specification documentation by provinding lookup for names, defined in other files.

There is a menu entry to switch the Package off (and on again)

Setup

1. Install the atom editor
2. Visit the package manager (in atoms settings) and make sure sure the package autocomplete-plus is installed
3. Install the saml-test-spec-editor package from the package manager
4. Use your preferred github client to clone the saml test specifications repository TODO: add link here
5. In atom, add the repository directory as a new project
6. You will be also interested in the asciidoc-preview package.

Providing documents

Files providing documents have to be in the 'documents' folder (or subfolders). You can provide documents in the tables in these files.

These tables need to have exactly 3 columns: ID, title and URL

Providing document locations

Files providing locations whithin documents have to be in the 'location' folder (or subfulders). You can provide locations in the tables in these files. The file name of this file has to match exactly the filename of the URL given in the documents lists. The extension is ignored so some-file-name.html will match to some-file-name.adoc

Providing requirements

Here the Editor helps by making suggestions in the columns for the document and location.

Files providing requirements have to be in the 'requirements' folder (or subfolders).

These tables need to have exactly 4 columns: Requirement-ID, socument, location, description.

Providing test cases

Here the editor will help by making suggestions for targets and requirements.

Files providing requirements have to be in the 'testcases' folder (or subfolders).

This files differ from the other files, as every test case is a table of two columns.

If the text in the first row reads "Test Target" the editor will suggest the available test targets, if it reads "Requirements" the editor will suggest the provided requirements.

Notes

Test targets are hardcoded in lib/stse-testtargets.coffee Table headers are ignored

Limitations

This package has only a very limited parser.

• Errors in the table format will distract the parser on reading and creating suggestions
  • All tables need to be tables for the file type given
  • The tables must have the correct number of columns
• No decorations on the tables

Development

autoreload on changes:

Look into the publish.sh and setupdevel.sh files to get hints about how to get development setup.