src/vnet/adj/adj.h

# Copyright (c) 2022 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.

# Idea of this file is motivated by OpenDylight,
# especially its Integration/Test sub-project.

# This file requires active virtualenv with tox package installed,
# or python-tox system package installed.

# Usage:
# cd to CSIT root (other directories might use different tox.ini)
#   $ tox
# will execute all default checkers.
#  $ tox -e pylint
# will execute only checkers (or fixers) defined in "pylint" tox environment.

[tox]
# Fast and brief checkers to front, slow or verbose checkers to back.
envlist = job_spec, copyright_year, gpl_license, model_version,
    new_line_length, line_length, autogen, pylint, doc_verify

# The following is needed as tox requires setup.py by default.
skipsdist = true
# Just a shorthand to avoid long lines.
script_dir = ./resources/libraries/bash/entry/tox

# TODO: Tox prints various warnings. Figure them out and fix them.

# Recommended ordering withinn testenv definition:
# + General comments.
# + ignore_outcome for non-voting checkers,
# + setenv (PYTHONPATH) for Python-using checkers and fixers.
# + Other Python stuff (e.g. basepython and deps for pylint).
# + whitelist_externals to enable bash.
# + Commands with a single bash to launch the corresponding script.

# Keep testenvs sorted alphabetically, please.

[testenv:autogen]
setenv = PYTHONPATH = {toxinidir}
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/autogen.sh

[testenv:copyright_year]
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/copyright_year.sh

[testenv:doc_verify]
# Fix all documentation error before enabling voting.
ignore_outcome = true
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/doc_verify.sh

[testenv:gpl_license]
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/gpl_license.sh

[testenv:line_length]
# Fix all transgressions and remove the ignore_outcome flag.
ignore_outcome = true
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/line.sh

[testenv:model_version]
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/model_version.sh

[testenv:new_line_length]
# Adding .svg, big .rst tables, .yaml and similar still requires long lines.
# As current implementation is too dumb to filter those out,
# the checker has to remain non-voting.
ignore_outcome = true
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/new_line.sh

[testenv:pylint]
# Run pylint, but hide its return value until python warnings are cleared.
ignore_outcome = true
setenv = PYTHONPATH = {toxinidir}
basepython = python3
deps =
    pylint==2.4.3
    -r ./requirements.txt
whitelist_externals = /bin/bash
commands = bash {[tox]script_dir}/pylint.sh

# Keep testenvs sorted alphabetically, please.

# TODO: Add a checker against unresolved merge conflicts.
#       See: https://gerrit.fd.io/r/c/vpp/+/26956
# TODO: Create voting "pylint violations should not increase" checker.
# TODO: Create voting checker to reject suites with Force Tags of other suite.
# TODO: Create voting checker against tags not in tag_documentation.rst file.
# TODO: Create Robot suite Documentation checker (backslash if not next mark).
# TODO: Create .yaml specific checker, so people can override long line check.
# TODO: Create .rst specific checker, if there is one allowing
#       to override line check.
# TODO: You get the idea, replace line checker with something smarter
#       wherever possible.
Age	Commit message (Expand)	Author	Files	Lines
2018-12-07	FIB recusrion loop checks traverse midchain adjacencies	Neale Ranns	1	-5/+58
2018-07-20	IP directed broadcast	Neale Ranns	1	-0/+10
2018-06-11	MTU: Software interface / Per-protocol MTU support	Ole Troan	1	-6/+0
2018-02-21	Adj Delegates; don't store raw pointers	Neale Ranns	1	-1/+1
2018-02-19	Adjacency Delegate updates	Neale Ranns	1	-1/+1
2018-02-12	Improve MTU handling	Neale Ranns	1	-0/+6
2018-01-30	Allow the provider of a midchain adjacency to pass context data that is retur...	Neale Ranns	1	-1/+6
2017-04-07	MPLS Mcast	Neale Ranns	1	-0/+6
2017-04-06	BFD-FIB interactions	Neale Ranns	1	-0/+15
2017-04-03	Adjacency layout change and move to vnet/adj	Neale Ranns	1	-2/+218
2017-03-17	Cache a 'has-features' flag on the adjacency for faster access. Reclaim the n...	Neale Ranns	1	-0/+6
2017-03-07	make per-adj counters configurable	Neale Ranns	1	-0/+15
2017-01-27	IP Multicast FIB (mfib)	Neale Ranns	1	-1/+0
2016-12-28	Reorganize source tree to use single autotools instance	Damjan Marion	1	-0/+122