1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
#!/usr/bin/env python3
import sys
import os
import ipaddress
import yaml
from pprint import pprint
import re
from jsonschema import validate, exceptions
import argparse
from subprocess import run, PIPE
# VPP feature JSON schema
schema = {
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"maintainer": {"$ref": "#/definitions/maintainers"},
"state": {"type": "string",
"enum": ["production", "experimental", "development"]},
"features": {"$ref": "#/definitions/features"},
"missing": {"$ref": "#/definitions/features"},
"properties": {"type": "array",
"items": {"type": "string",
"enum": ["API", "CLI", "STATS",
"MULTITHREAD"]},
},
},
"additionalProperties": False,
"definitions": {
"maintainers": {
"anyof": [{
"type": "array",
"items": {"type": "string"},
"minItems": 1,
},
{"type": "string"}],
},
"featureobject": {
"type": "object",
"patternProperties": {
"^.*$": {"$ref": "#/definitions/features"},
},
},
"features": {
"type": "array",
"items": {"anyOf": [{"$ref": "#/definitions/featureobject"},
{"type": "string"},
]},
"minItems": 1,
},
},
}
def filelist_from_git_status():
filelist = []
git_status = 'git status --porcelain */FEATURE.yaml'
rv = run(git_status.split(), stdout=PIPE, stderr=PIPE)
if rv.returncode != 0:
sys.exit(rv.returncode)
for l in rv.stdout.decode('ascii').split('\n'):
if len(l):
filelist.append(l.split()[1])
return filelist
def filelist_from_git_ls():
filelist = []
git_ls = 'git ls-files :(top)*/FEATURE.yaml'
rv = run(git_ls.split(), stdout=PIPE, stderr=PIPE)
if rv.returncode != 0:
sys.exit(rv.returncode)
for l in rv.stdout.decode('ascii').split('\n'):
if len(l):
filelist.append(l)
return filelist
def output_features(indent, fl):
for f in fl:
if type(f) is dict:
for k, v in f.items():
print('{}- {}'.format(' ' * indent, k))
output_features(indent + 2, v)
else:
print('{}- {}'.format(' ' * indent, f))
def output_markdown(features):
for k, v in features.items():
print('# {}'.format(v['name']))
if type(v['maintainer']) is list:
print('Maintainers: ' +
', '.join('{}'.format(m) for m in
v['maintainer']) + ' ')
else:
print('Maintainer: {} '.format(v['maintainer']))
print('State: {} \n'.format(v['state']))
print('{}\n'.format(v['description']))
output_features(0, v['features'])
if 'missing' in v:
print('\n## Missing')
output_features(0, v['missing'])
print()
def main():
parser = argparse.ArgumentParser(description='VPP Feature List.')
parser.add_argument('--validate', dest='validate', action='store_true',
help='validate the FEATURE.yaml file')
parser.add_argument('--git-status', dest='git_status', action='store_true',
help='Get filelist from git status')
parser.add_argument('--all', dest='all', action='store_true',
help='Validate all files in repository')
parser.add_argument('--markdown', dest='markdown', action='store_true',
help='Output feature table in markdown')
parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
default=sys.stdin)
args = parser.parse_args()
features = {}
if args.git_status:
filelist = filelist_from_git_status()
elif args.all:
filelist = filelist_from_git_ls()
else:
filelist = args.infile
for featurefile in filelist:
featurefile = featurefile.rstrip()
# Load configuration file
with open(featurefile) as f:
cfg = yaml.load(f, Loader=yaml.SafeLoader)
try:
validate(instance=cfg, schema=schema)
except exceptions.ValidationError:
print('File does not validate: {}'.format(featurefile),
file=sys.stderr)
raise
features[featurefile] = cfg
if args.markdown:
output_markdown(features)
if __name__ == '__main__':
main()
|
