From: Paul Vinciguerra Date: Sun, 3 Nov 2019 23:44:31 +0000 (-0500) Subject: build: add yaml file linting to make checkstyle X-Git-Tag: v20.05-rc0~442 X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commitdiff_plain;h=6b0dd5502489c83cc4a0e6e9240b41a9bb3f0ed6 build: add yaml file linting to make checkstyle Type: feature fts and trex rely on yaml config files. Verify that they are valid, so comitters can catch errors early. Change-Id: Ide0bb276659119c59bdbbc8b8155e37562a648b8 Signed-off-by: Paul Vinciguerra --- diff --git a/Makefile b/Makefile index 1a11da8ceda..b8c8a781997 100644 --- a/Makefile +++ b/Makefile @@ -68,7 +68,7 @@ DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev DEB_DEPENDS += python-all python3-all python3-setuptools python-dev DEB_DEPENDS += python-virtualenv python-pip libffi6 check DEB_DEPENDS += libboost-all-dev libffi-dev python3-ply libmbedtls-dev -DEB_DEPENDS += cmake ninja-build uuid-dev python3-jsonschema python3-yaml +DEB_DEPENDS += cmake ninja-build uuid-dev python3-jsonschema python3-yaml yamllint ifeq ($(OS_VERSION_ID),14.04) DEB_DEPENDS += libssl-dev else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8) @@ -89,6 +89,7 @@ RPM_DEPENDS += selinux-policy selinux-policy-devel RPM_DEPENDS += ninja-build RPM_DEPENDS += libuuid-devel RPM_DEPENDS += mbedtls-devel +RPM_DEPENDS += yamllint ifeq ($(OS_ID),fedora) RPM_DEPENDS += dnf-utils @@ -558,6 +559,7 @@ cscope: cscope.files checkstyle: @build-root/scripts/checkstyle.sh + yamllint $(WS_ROOT)/src fixstyle: @build-root/scripts/checkstyle.sh --fix diff --git a/src/plugins/flowprobe/FEATURE.yaml b/src/plugins/flowprobe/FEATURE.yaml index f3388fc2c25..66382433d03 100644 --- a/src/plugins/flowprobe/FEATURE.yaml +++ b/src/plugins/flowprobe/FEATURE.yaml @@ -1,3 +1,4 @@ +--- name: IPFIX probe maintainer: Ole Troan features: @@ -6,8 +7,8 @@ features: - Recording of L2, L3 and L4 information description: "IPFIX flow probe. Works in the L2, or IP input feature path." missing: - - Output path - - Export over IPv6 - - Export over TCP/SCTP + - Output path + - Export over IPv6 + - Export over TCP/SCTP state: production properties: [API, CLI, STATS, MULTITHREAD] diff --git a/src/plugins/mactime/FEATURE.yaml b/src/plugins/mactime/FEATURE.yaml index fbc0a6cccdd..f24450e8375 100644 --- a/src/plugins/mactime/FEATURE.yaml +++ b/src/plugins/mactime/FEATURE.yaml @@ -1,3 +1,4 @@ +--- name: Time-range-based MAC-address filter (mactime) maintainer: Dave Barach features: diff --git a/src/plugins/map/FEATURE.yaml b/src/plugins/map/FEATURE.yaml index 0d156354b4c..b5055914480 100644 --- a/src/plugins/map/FEATURE.yaml +++ b/src/plugins/map/FEATURE.yaml @@ -1,8 +1,9 @@ +--- name: Mapping of Address and Port (MAP) maintainer: Ole Troan features: - LW46 BR (RFC7596): - - Fragmentation and Reassembly + - Fragmentation and Reassembly - MAP-E BR (RFC7597) - MAP-T BR (RFC7599) description: "IPv4 as a service mechanisms. Tunnel or translate diff --git a/src/plugins/mdata/FEATURE.yaml b/src/plugins/mdata/FEATURE.yaml index 404739ee54a..9bd11e415a2 100644 --- a/src/plugins/mdata/FEATURE.yaml +++ b/src/plugins/mdata/FEATURE.yaml @@ -1,8 +1,10 @@ +--- name: Buffer Metadata Change Tracker (mdata) maintainer: Dave Barach features: - Buffer Metadata Change Tracker -description: Buffer Metadata Change Tracker + |- + Buffer Metadata Change Tracker Uses the before / after graph node main loop performance callback hooks to snapshoot buffer metadata, then compare and summarize results per-node. diff --git a/src/plugins/nat/extras/trex_cfg.yaml b/src/plugins/nat/extras/trex_cfg.yaml index 6fd1ab007d8..0388476ea78 100644 --- a/src/plugins/nat/extras/trex_cfg.yaml +++ b/src/plugins/nat/extras/trex_cfg.yaml @@ -1,5 +1,5 @@ -### Config file generated by dpdk_setup_ports.py ### - +# Config file generated by dpdk_setup_ports.py ## +--- - port_limit: 2 version: 2 interfaces: ['04:00.0', '04:00.1'] @@ -14,8 +14,7 @@ master_thread_id: 0 latency_thread_id: 8 dual_if: - - socket: 0 - threads: [1,2,3,4,5,6,7] - - socket: 1 - threads: [9,10,11,12,13,14,15] - + - socket: 0 + threads: [1, 2, 3, 4, 5, 6, 7] + - socket: 1 + threads: [9, 10, 11, 12, 13, 14, 15] diff --git a/src/vnet/devices/af_packet/FEATURE.yaml b/src/vnet/devices/af_packet/FEATURE.yaml index 00630140910..4a057c4ac96 100644 --- a/src/vnet/devices/af_packet/FEATURE.yaml +++ b/src/vnet/devices/af_packet/FEATURE.yaml @@ -1,9 +1,15 @@ +--- name: host-interface Device (AF_PACKET) maintainer: Damjan Marion features: - L4 checksum offload -description: "Create a host interface that will attach to a linux AF_PACKET interface, one side of a veth pair. The veth pair must already exist. Once created, a new host interface will exist in VPP with the name 'host-', where '' is the name of the specified veth pair. Use the 'show interface' command to display host interface details." +description: "Create a host interface that will attach to a linux AF_PACKET + interface, one side of a veth pair. The veth pair must + already exist. Once created, a new host interface will + exist in VPP with the name 'host-', where '' + is the name of the specified veth pair. Use the 'show interface' + command to display host interface details." missing: - - API dump details beyond sw_if_index and name + - API dump details beyond sw_if_index and name state: production properties: [API, CLI, STATS, MULTITHREAD] diff --git a/src/vnet/devices/netmap/FEATURE.yaml b/src/vnet/devices/netmap/FEATURE.yaml index dfc32bb0c68..e23e5c243e7 100644 --- a/src/vnet/devices/netmap/FEATURE.yaml +++ b/src/vnet/devices/netmap/FEATURE.yaml @@ -1,9 +1,12 @@ +--- name: Netmap Device maintainer: Damjan Marion features: - L4 checksum offload -description: "Create a netmap interface, which is a high speed user-space interface that allows VPP to patch into a linux namespace, a linux container, or a physical NIC without the use of DPDK." +description: "Create a netmap interface, which is a high speed user-space + interface that allows VPP to patch into a linux namespace, + a linux container, or a physical NIC without the use of DPDK." missing: - - API dump + - API dump state: production properties: [API, CLI, STATS, MULTITHREAD] diff --git a/src/vnet/devices/pipe/FEATURE.yaml b/src/vnet/devices/pipe/FEATURE.yaml index 0886ec5d896..dbe3b3b7153 100644 --- a/src/vnet/devices/pipe/FEATURE.yaml +++ b/src/vnet/devices/pipe/FEATURE.yaml @@ -1,8 +1,12 @@ +--- name: Pipe Device maintainer: Damjan Marion features: - L4 checksum offload -description: "Create a pipe device interface, which can pass packets bidirectionally in one side of the pipe to the other side of the pipe. While similar in behavior to a unix pipe, it is not a host-based pipe." +description: "Create a pipe device interface, which can pass packets + bidirectionally in one side of the pipe to the other side of + the pipe. While similar in behavior to a unix pipe, it is + not a host-based pipe." missing: - does not use hw-address - does not support tagged traffic diff --git a/src/vnet/devices/tap/FEATURE.yaml b/src/vnet/devices/tap/FEATURE.yaml index 2ca6057b118..ce2c510cc9b 100644 --- a/src/vnet/devices/tap/FEATURE.yaml +++ b/src/vnet/devices/tap/FEATURE.yaml @@ -1,8 +1,10 @@ +--- name: Tap Device maintainer: damarion@cisco.com sluong@cisco.com sykazmi@cisco.com features: - Virtio -description: "Create a tap v2 device interface, which connects to a tap interface on the host system." +description: "Create a tap v2 device interface, which connects to a + tap interface on the host system." missing: - API dump filtering by sw_if_index diff --git a/src/vnet/devices/virtio/FEATURE.yaml b/src/vnet/devices/virtio/FEATURE.yaml index 69f4739265b..c98689e2fb9 100644 --- a/src/vnet/devices/virtio/FEATURE.yaml +++ b/src/vnet/devices/virtio/FEATURE.yaml @@ -1,7 +1,9 @@ +--- name: Virtio PCI Device maintainer: Mohsin Kazmi features: - - connection to the emulated pci interface presented to vpp from the host interface. + - connection to the emulated pci interface presented to vpp from + the host interface. description: "Create a virtio-backed PCI device interface" missing: - API dump filtering by sw_if_index diff --git a/src/vnet/ipip/FEATURE.yaml b/src/vnet/ipip/FEATURE.yaml index 6e670fc3e74..010fa1ec527 100644 --- a/src/vnet/ipip/FEATURE.yaml +++ b/src/vnet/ipip/FEATURE.yaml @@ -1,22 +1,24 @@ +--- name: IP in IP tunnelling maintainer: Ole Troan features: - IPv4/IPv6 over IPv4/IPv6 encapsulation: - - Fragmentation and Reassembly - - Configurable MTU - - Inner to outer Traffic Class / TOS copy - - Configurable Traffic Class / TOS + - Fragmentation and Reassembly + - Configurable MTU + - Inner to outer Traffic Class / TOS copy + - Configurable Traffic Class / TOS - ICMPv4 / ICMPv6 proxying - 6RD (RFC5969): - - Border Relay + - Border Relay -description: "Implements IP{v4,v6} over IP{v4,v6} tunnelling as - described in RFC2473. This module also implement the border relay of - 6RD (RFC5969)." +description: |- + Implements IP{v4,v6} over IP{v4,v6} tunnelling as + described in RFC2473. This module also implements the + border relay of 6RD (RFC5969). state: production properties: [API, CLI, STATS, MULTITHREAD] missing: - Tunnel PMTUD - Tracking of FIB state for tunnel state - - IPv6 extension headers (Tunnel encapsulation limit option) \ No newline at end of file + - IPv6 extension headers (Tunnel encapsulation limit option)