fix(core): 3n-icx topology
[csit.git] / resources / libraries / bash / entry / check / README.txt
1 # Copyright (c) 2021 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 This directory contains checker scripts and other files they need.
15 Each checker script is assumed to be run from tox,
16 when working directory is set to ${CSIT_DIR}.
17 Each script should:
18 + Return nonzero exit code when it fails.
19 ++ The tox might ignore the code when the check is not blocking.
20 + Write less verbose output to stderr.
21 + Write (to stderr) PASSED or FAILED to help with debugging.
22 + Direct more verbose output to appropriately named .log file.
23 + Only the output suitable for automated processing by an external caller
24   should be written to stdout.
25 ++ The level of "less verbose" depends on check and state of codebase.
26 + TODO: Should we carefully document which files are
27   whitelisted/blacklisted for a particulat check?