Skip to content

Test specification template#971

Merged
matsduf merged 11 commits into
zonemaster:developfrom
matsduf:test-specification-template
Sep 20, 2021
Merged

Test specification template#971
matsduf merged 11 commits into
zonemaster:developfrom
matsduf:test-specification-template

Conversation

@matsduf

@matsduf matsduf commented Jul 12, 2021

Copy link
Copy Markdown
Contributor

Purpose

The test case specifications have evolved over the years, and different specifications have different layouts. Originally, the test message tags were not included, then they were added and then moved. The layout has changed gradually, and not always consistently since the only template available has been a recently updated or created specification.

Changes

This PR adds two specifications and one template. The specifications are of "Message Tag" and "Test Case Identifier", respectively. The template is for a test case specification, and is dependent on the twp specifications.

The template should not be considered to be The Final Template, and should be updated when needed.

How to test this PR

This documentation only, and no testing is relevant.

@matsduf matsduf added the A-Documentation Area: Documentation only. label Jul 12, 2021
@matsduf matsduf added this to the v2021.2 milestone Jul 12, 2021
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated

@matsduf matsduf left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks.

Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
@matsduf matsduf requested a review from hannaeko July 13, 2021 10:27
@matsduf

matsduf commented Jul 19, 2021

Copy link
Copy Markdown
Contributor Author

@blacksponge, please review again.

hannaeko
hannaeko previously approved these changes Jul 20, 2021
matsduf added a commit to matsduf/zonemaster that referenced this pull request Jul 22, 2021
* Rearranged to conform to the draft template (PR zonemaster#971).
* The test procedure has been updated to not output a message for every name
  server matching a criteria, but for the whole group of such servers.
* Removed messages that would duplicate other test cases.
matsduf added a commit to matsduf/zonemaster that referenced this pull request Jul 22, 2021
* Rearranged to conform to the draft template (PR zonemaster#971).
* The test procedure has been updated to not output a message for every name
  server matching a criteria, but for the whole group of such servers.
* Removed messages that would duplicate other test cases.

@ghost ghost left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I find it nice to have an explanation on the specification template.

Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment on lines +76 to +77
> > first column, the default severity level in the second, and a statement on
> > when the message is outputted in the third. Always use the same table set-up,

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

and a statement on when the message is outputted in the third

If I don't get it wrong, this is the 4th column (not the third). Maybe you could also add something about the third column as well.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

When the text was written the now third column was not there. It was added afterwards. Fixed.

Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
@matsduf matsduf mentioned this pull request Jul 28, 2021
matsduf added a commit to matsduf/zonemaster that referenced this pull request Jul 28, 2021
* Adapts to draft template (zonemaster#971)
* Messages are updated.
* Informational messages removed to keep down the amount of messages.
@matsduf matsduf mentioned this pull request Jul 28, 2021
matsduf added a commit to matsduf/zonemaster that referenced this pull request Jul 28, 2021
* Adapts to draft template (zonemaster#971)
* Messages are updated.
* Informational messages removed to keep down the amount of messages.
matsduf added a commit to matsduf/zonemaster that referenced this pull request Jul 28, 2021
* Adapts to draft template (zonemaster#971)
* Messages are updated.
* Informational messages removed to keep down the amount of messages.
@matsduf matsduf requested review from a user and hannaeko July 29, 2021 07:09
@matsduf

matsduf commented Jul 29, 2021

Copy link
Copy Markdown
Contributor Author

@blacksponge and @PNAX, please re-review after my fixes.

Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
@matsduf matsduf requested a review from a user July 29, 2021 09:49
ghost
ghost previously approved these changes Jul 29, 2021
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
@matsduf matsduf requested a review from a user August 1, 2021 14:56
ghost
ghost previously approved these changes Aug 2, 2021
mattias-p
mattias-p previously approved these changes Aug 17, 2021

@mattias-p mattias-p left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks good. I have attached a few suggestions.

Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
Comment thread docs/internal-documentation/templates/specifications/tests/Template01.md Outdated
@matsduf matsduf dismissed stale reviews from mattias-p and ghost via a3bf667 September 10, 2021 15:05
@matsduf

matsduf commented Sep 10, 2021

Copy link
Copy Markdown
Contributor Author

@mattias-p and @PNAX, can you re-review? I did some smaller updates based on comments by @mattias-p.

mattias-p
mattias-p previously approved these changes Sep 20, 2021

@mattias-p mattias-p left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I found a spelling error. Apart from that I think this is good enough.


The test level abbreviation is always as follows:

Test level name | Example Test case ID | Abreviation | Prefix | Example message tag

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Abreviation -> Abbreviation

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed. You have re-approve.

@matsduf

matsduf commented Sep 20, 2021

Copy link
Copy Markdown
Contributor Author

@PNAX, are you fine with this PR? Can you review and possibly approve?

@matsduf matsduf merged commit 61ce5a5 into zonemaster:develop Sep 20, 2021
@matsduf matsduf deleted the test-specification-template branch September 20, 2021 19:59
tgreenx pushed a commit to tgreenx/zonemaster that referenced this pull request Jan 3, 2022
matsduf added a commit to matsduf/zonemaster that referenced this pull request Jul 15, 2022
* Adapts to draft template (zonemaster#971)
* Messages are updated.
* Informational messages removed to keep down the amount of messages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Documentation Area: Documentation only.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants