Page MenuHomePhabricator

Expand scap documentation, especially plugins and cli stuff
ClosedPublic

Authored by mmodell on Oct 5 2016, 2:33 AM.

Details

Summary

refs T142880

Test Plan

tox -edoc

Diff Detail

Repository
rMSCA Scap
Branch
plugin-docs (branched from master)
Lint
Lint Passed
Unit
Tests Passed
Build Status
Buildable 1099
Build 1602: build-beta-package.debJenkins
Build 1601: differential-jessieJenkins
Build 1600: arc lint + arc unit

Event Timeline

mmodell retitled this revision from to Expand scap documentation, especially plugins and cli stuff.
mmodell updated this object.
mmodell edited the test plan for this revision. (Show Details)
mmodell added reviewers: mobrovac, thcipriani.

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161005023333.137~1.gbpbe9198
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/137/ for more details.

mmodell edited edge metadata.

i h8 pep8

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161005023551.138~1.gbpbe9198
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/138/ for more details.

The main documentation addition is at D403#1a37b0be

It would also be helpful to include information on how to test the modules.

docs/api.rst
23

Built-in ?

scap/ansi.py
7

We're in TLS-only mode - https :P

scap/plugins/__init__.py
11

Could we explicitly list those locations here?

mmodell marked 3 inline comments as done.
mmodell edited edge metadata.

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161005194301.142~1.gbp82d622
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/142/ for more details.

scap/plugins/__init__.py
118–136

the only change here is added error handling: an exception while evaluating a plugin shouldn't cause the entire scap application to fail

Still waiting on:

In D403#7890, @mobrovac wrote:

It would also be helpful to include information on how to test the modules.

scap/plugins/__init__.py
40

built-in.

In D403#7934, @mobrovac wrote:

Still waiting on:

In D403#7890, @mobrovac wrote:

It would also be helpful to include information on how to test the modules.

Do you mean unit testing or just how to run them? Currently there is no support for unit testing but we could perhaps come up with a standard test entry point and a 'scap test' sub-command that calls it?

  • extract scap say into a separate plugin say.py

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161005201553.143~1.gbp82d622
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/143/ for more details.

In D403#7936, @mmodell wrote:
In D403#7934, @mobrovac wrote:

Still waiting on:

In D403#7890, @mobrovac wrote:

It would also be helpful to include information on how to test the modules.

Do you mean unit testing or just how to run them? Currently there is no support for unit testing but we could perhaps come up with a standard test entry point and a 'scap test' sub-command that calls it?

I meant more in the debug/test-while-developing sense, but perhaps that would be better left for another patch (even though, this information should be considered essential if we want people to actually use the plugins capability).

+1 to the scap test idea!

  • Generate scap manpage and include it in scap.deb

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161005223811.144~1.gbp82d622
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/144/ for more details.

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161006001241.145~1.gbp82d622
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/145/ for more details.

  • move manpage to the right place for debian packaging

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161006004228.147~1.gbp6e90f6
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/147/ for more details.

W: scap source: changelog-should-mention-nmu
N:
N: When you NMU a package, that fact should be mentioned on the first line
N: in the changelog entry. Use the words "NMU" or "Non-maintainer upload"
N: (case insensitive).
N:
N: Maybe you didn't intend this upload to be a NMU, in that case, please
N: double-check that the most recent entry in the changelog is
N: byte-for-byte identical to the maintainer or one of the uploaders. If
N: this is a local package (not intended for Debian), you can suppress this
N: warning by putting "local" in the version number or "local package" on
N: the first line of the changelog entry.
N:
N: Refer to Debian Developer's Reference section 5.11.3 (Using the DELAYED/
N: queue) for details.
N:
N: Severity: normal, Certainty: certain
N:
N: Check: nmu, Type: source
N:
W: scap source: source-nmu-has-incorrect-version-number 3.3.0-1+0~20161007183745.151~1.gbp624959
N:
N: A source NMU should have a Debian
https://integration.wikimedia.org/ci/job/beta-build-deb/151/ for more details.

demon added a reviewer: demon.
This revision is now accepted and ready to land.Oct 19 2016, 7:21 PM
This revision was automatically updated to reflect the committed changes.