diff options
author | Vratko Polak <vrpolak@cisco.com> | 2018-09-14 17:09:35 +0200 |
---|---|---|
committer | Vratko Polak <vrpolak@cisco.com> | 2019-02-27 09:02:55 +0000 |
commit | 694b418272e9d7670ac69d477ed731bb7445b65a (patch) | |
tree | 2ec006cb61562bddabbf4cd68ba8ef5963694768 /resources/libraries/bash/entry/check/README.txt | |
parent | 228c27de3986731fc6be39445dd0b23b4003d78c (diff) |
Add tox.ini and few checker scripts
The plan is to change csit-validate-pylint-master job
to fail if (and only if) tox fails.
This will allow us to easily add checks,
with or without the voting power.
Each check produces log (ignored in .gitignore)
the voting job can archive.
+ Made autogen quiet by default, to avoid spam in autogen checker.
+ Unified the way direct csit subdirectories are git-ignored.
Change-Id: I6477b1ef7da6d3e30f68c5850d04900cc52f431e
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'resources/libraries/bash/entry/check/README.txt')
-rw-r--r-- | resources/libraries/bash/entry/check/README.txt | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/resources/libraries/bash/entry/check/README.txt b/resources/libraries/bash/entry/check/README.txt new file mode 100644 index 0000000000..a72274464c --- /dev/null +++ b/resources/libraries/bash/entry/check/README.txt @@ -0,0 +1,27 @@ +# Copyright (c) 2019 Cisco and/or its affiliates. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +This directory contains checker scripts and other files they need. +Each checker script is assumed to be run from tox, +when working directory is set to ${CSIT_DIR}. +Each script should: ++ Return nonzero exit code when it fails. +++ The tox might ignore the code when the check is not blocking. ++ Write less verbose output to stderr. ++ Write (to stderr) PASSED or FAILED to help with debugging. ++ Direct more verbose output to appropriately named .log file. ++ Only the output suitable for automated processing by an external caller + should be written to stdout. +++ The level of "less verbose" depends on check and state of codebase. ++ TODO: Should we carefully document which files are + whitelisted/blacklisted for a particulat check? |