/
rules.py
1410 lines (1224 loc) · 51.3 KB
/
rules.py
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.
#
import os
import re
from SCons.Builder import Builder
from SCons.Action import Action
from SCons.Errors import convert_to_BuildError
from SCons.Script import AddOption, GetOption, SetOption
from distutils.version import LooseVersion, StrictVersion
import json
import SCons.Util
import subprocess
import sys
import time
import platform
import getpass
import warnings
def GetPlatformInfo(env):
'''
Returns same 3-tuple as platform.dist()/platform.linux_distribution() (caches tuple)
'''
GetPlatformInfo.__dict__.setdefault('system', None)
GetPlatformInfo.__dict__.setdefault('distro', None)
if not GetPlatformInfo.system: GetPlatformInfo.system = platform.system()
if not GetPlatformInfo.distro:
if GetPlatformInfo.system == 'Linux':
GetPlatformInfo.distro = platform.linux_distribution()
elif GetPlatformInfo.system == 'Darwin':
GetPlatformInfo.distro = ('Darwin','','')
else:
GetPlatformInfo.distro = ('Unknown','','')
return GetPlatformInfo.distro
def PlatformExclude(env, **kwargs):
"""
Return True if platform_excludes list includes a tuple that matches this host/version
"""
if 'platform_exclude' not in kwargs: return False
from distutils.version import LooseVersion
distro = env.GetPlatformInfo()
this_ver = LooseVersion(distro[1])
for (p,v) in kwargs['platform_exclude']:
if distro[0] != p: continue
excl_ver = LooseVersion(v)
if this_ver >= excl_ver: return True
return False
def GetTestEnvironment(test):
env = { }
try:
with open('controller/ci_unittests.json') as json_file:
d = json.load(json_file)
for e in d["contrail-control"]["environment"]:
for t in e["tests"]:
if re.compile(t).match(test):
for tup in e["tuples"]:
tokens = tup.split("=")
env[tokens[0]] = tokens[1]
except:
pass
return env
def RunUnitTest(env, target, source, timeout = 300):
if env['ENV'].has_key('BUILD_ONLY'):
return
import subprocess
if env['ENV'].has_key('CONTRAIL_UT_TEST_TIMEOUT'):
timeout = int(env['ENV']['CONTRAIL_UT_TEST_TIMEOUT'])
test = str(source[0].abspath)
logfile = open(target[0].abspath, 'w')
# env['_venv'] = {target: venv}
tgt = target[0].name
if '_venv' in env and tgt in env['_venv'] and env['_venv'][tgt]:
cmd = ['/bin/bash', '-c', 'source %s/bin/activate && %s' % (
env[env['_venv'][tgt]]._path, test)]
elif env.get('OPT') == 'valgrind':
cmd = ['valgrind', '--track-origins=yes', '--num-callers=50',
'--show-possibly-lost=no', '--leak-check=full',
'--error-limit=no', test]
else:
cmd = [test]
ShEnv = env['ENV'].copy()
ShEnv.update({env['ENV_SHLIB_PATH']: 'build/lib',
'DB_ITERATION_TO_YIELD': '1',
'TOP_OBJECT_PATH': env['TOP'][1:]})
ShEnv.update(GetTestEnvironment(test))
# Use gprof unless NO_HEAPCHECK is set or in CentOS
heap_check = ShEnv.has_key('NO_HEAPCHECK') == False
if heap_check:
try:
# Skip HEAPCHECK in CentOS 6.4
subprocess.check_call("grep -q \"CentOS release 6.4\" /etc/issue 2>/dev/null", shell=True)
heap_check = False
except:
pass
if heap_check:
ShEnv['HEAPCHECK'] = 'normal'
ShEnv['PPROF_PATH'] = 'build/bin/pprof'
# Fix for frequent crash in gperftools ListerThread during exit
# https://code.google.com/p/gperftools/issues/detail?id=497
ShEnv['LD_BIND_NOW'] = '1'
if 'CONCURRENCY_CHECK_ENABLE' not in ShEnv:
ShEnv['CONCURRENCY_CHECK_ENABLE'] = 'true'
proc = subprocess.Popen(cmd, stdout=logfile, stderr=logfile, env=ShEnv)
# 60 second timeout
for i in range(timeout):
code = proc.poll()
if not code is None:
break
time.sleep(1)
if code is None:
proc.kill()
logfile.write('[ TIMEOUT ] ')
print(test + '\033[91m' + " TIMEOUT" + '\033[0m')
raise convert_to_BuildError(code)
return
if code == 0:
print(test + '\033[94m' + " PASS" + '\033[0m')
else:
logfile.write('[ FAILED ] ')
if code < 0:
logfile.write('Terminated by signal: ' + str(-code) + '\n')
else:
logfile.write('Program returned ' + str(code) + '\n')
print(test + '\033[91m' + " FAIL" + '\033[0m')
raise convert_to_BuildError(code)
def TestSuite(env, target, source):
if len(source):
for test in env.Flatten(source):
# UnitTest() may have tagged tests with skip_run attribute
if getattr( test.attributes, 'skip_run', False ): continue
cmd = env.Command(test.abspath + '.log', test, RunUnitTest)
# If BUILD_ONLY set, do not alias foo.log target, to avoid
# invoking the RunUnitTest() as a no-op (i.e., this avoids
# some log clutter)
if 'BUILD_ONLY' in env['ENV']:
env.Alias(target, test)
else:
env.AlwaysBuild(cmd)
env.Alias(target, cmd)
return target
def GetVncAPIPkg(env):
h,v = env.GetBuildVersion()
return '/api-lib/dist/vnc_api-%s.tar.gz' % v
sdist_default_depends = [
'/config/common/dist/cfgm_common-0.1dev.tar.gz',
'/tools/sandesh/library/python/dist/sandesh-0.1dev.tar.gz',
'/sandesh/common/dist/sandesh-common-0.1dev.tar.gz',
]
# SetupPyTestSuiteWithDeps
#
# Function to provide consistent 'python setup.py run_tests' interface
#
# The var *args is expected to contain a list of dependencies. If
# *args is empty, then above sdist_default_depends + the vnc_api tgz
# is used.
#
# This method is mostly to be used by SetupPyTestSuite(), but there
# is one special-case instance (controller/src/api-lib) that needs
# to use this builder directly, so that it can provide explicit list
# of dependencies.
#
def SetupPyTestSuiteWithDeps(env, sdist_target, *args, **kwargs):
use_tox = kwargs['use_tox'] if 'use_tox' in kwargs else False
buildspace_link = os.environ.get('CONTRAIL_REPO')
if buildspace_link:
# in CI environment shebang limit exceeds for python
# in easy_install/pip, reach to it via symlink
top_dir = env.Dir(buildspace_link + '/' + env.Dir('.').path)
else:
top_dir = env.Dir('.')
cmd_base = 'bash -c "set -o pipefail && cd ' + env.Dir(top_dir).path + ' && %s 2>&1 | tee %s.log"'
# if BUILD_ONLY, we create a "pass through" dependency... the test target will end up depending
# (only) on the original sdist target
if 'BUILD_ONLY' in env['ENV']:
test_cmd = cov_cmd = sdist_target
else:
cmd_str = 'tox' if use_tox else 'python setup.py run_tests'
test_cmd = env.Command('test.log', sdist_target, cmd_base % (cmd_str, "test"))
cmd_str += ' -e cover' if use_tox else ' --coverage'
cov_cmd = env.Command('coveragetest.log', sdist_target, cmd_base % (cmd_str, 'coveragetest'))
# If *args is not empty, move all arguments to kwargs['sdist_depends']
# and issue a warning. Also make sure we are not using old and new method
# of passing dependencies.
if len(args) and 'sdist_depends' in kwargs:
print("Do not both pass dependencies as *args"
"and use sdist_depends at the same time.")
Exit(1)
# during transition we have to support both types of targets
# as dependencies. This function allows us to mix both SCons targets
# and file paths.
def _rewrite_file_dependencies(deps):
"""Update direct file dependencies to prepend build path"""
# file dependencies need absulute paths
file_depends = [env['TOP'] + x for x in deps if x.startswith('/')]
# explicitly define each target as Alias, in case it hasn't yet been
# defined in SConscript.
scons_depends = [env.Alias(x) for x in deps if not x.startswith('/')]
return file_depends + scons_depends
if len(args):
warnings.warn("Don't pass dependencies as arguments pointing"
" to tarballs, instead pass scons aliases"
" as sdist_depends.")
full_depends = _rewrite_file_dependencies(env.Flatten(args))
else:
full_depends = _rewrite_file_dependencies(kwargs['sdist_depends'])
# When BUILD_ONLY is defined, test_cmd and cov_cmd are replaced with
# sdist_target - that can lead to circular dependencies when tests
# depend on other components.
if 'BUILD_ONLY' not in env['ENV']:
env.Depends(test_cmd, full_depends)
env.Depends(cov_cmd, full_depends)
d = env.Dir('.').srcnode().path
env.Alias( d + ':test', test_cmd )
env.Alias( d + ':coverage', cov_cmd )
# env.Depends('test', test_cmd) # XXX This may need to be restored
env.Depends('coverage', cov_cmd)
# SetupPyTestSuite()
#
# General entry point for setting up 'python setup.py run_tests'. If
# using this method, the default dependencies are assumed. Any
# additional arguments in *args are *additional* dependencies
#
def SetupPyTestSuite(env, sdist_target, *args, **kwargs):
sdist_depends = sdist_default_depends + [ env.GetVncAPIPkg() ]
if len(args): sdist_depends += args
env.SetupPyTestSuiteWithDeps(sdist_target,
sdist_depends=sdist_depends, **kwargs)
def setup_venv(env, target, venv_name, path=None):
p = path
if not p:
ws_link = os.environ.get('CONTRAIL_REPO')
if ws_link: p = ws_link + "/build/" + env['OPT']
else: p = env.Dir(env['TOP']).abspath
tdir = '/tmp/cache/%s/systemless_test' % getpass.getuser()
shell_cmd = ' && '.join ([
'cd %s' % p,
'mkdir -p %s' % tdir,
'[ -f %s/ez_setup-0.9.tar.gz ] || curl -o %s/ez_setup-0.9.tar.gz https://pypi.python.org/packages/source/e/ez_setup/ez_setup-0.9.tar.gz' % (tdir,tdir),
'[ -d ez_setup-0.9 ] || tar xzf %s/ez_setup-0.9.tar.gz' % tdir,
'[ -f %s/redis-2.6.13.tar.gz ] || (cd %s && wget https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/redis/redis-2.6.13.tar.gz)' % (tdir,tdir),
'[ -d ../redis-2.6.13 ] || (cd .. && tar xzf %s/redis-2.6.13.tar.gz)' % tdir,
'[ -f testroot/bin/redis-server ] || ( cd ../redis-2.6.13 && make PREFIX=%s/testroot install)' % p,
'virtualenv %s',
])
for t, v in zip(target, venv_name):
cmd = env.Command (v, '', shell_cmd % (v,))
env.Alias (t, cmd)
cmd._path = '/'.join ([p, v])
env[t] = cmd
return target
def venv_add_pip_pkg(env, v, pkg_list):
venv = env[v[0]]
# pkg_list can contain absolute filenames or a pip package and version.
targets = []
for pkg in pkg_list:
result = pkg.split('==')
if result:
name = result[0]
else:
name = pkg
if name[0] != '/':
targets.append(name)
pip = "/bin/bash -c \"source %s/bin/activate 2>/dev/null; pip" % venv._path
download_cache = ""
if sys.platform != 'win32':
pip_version = subprocess.check_output(
"%s --version | awk '{print \$2}'\"" % pip, shell=True).rstrip()
if pip_version < LooseVersion("6.0"):
tdir = '/tmp/cache/%s/systemless_test' % getpass.getuser()
download_cache = "--download-cache=%s" % (tdir)
cmd = env.Command(targets, None, '%s install %s %s"' %
(pip, download_cache, ' '.join(pkg_list)))
env.AlwaysBuild(cmd)
env.Depends(cmd, venv)
return cmd
def venv_add_build_pkg(env, v, pkg):
cmd = []
venv = env[v[0]]
for p in pkg:
t = 'build-' + p.replace('/', '_')
cmd += env.Command (t, '',
'/bin/bash -c "source %s/bin/activate; pushd %s && python setup.py install; popd"' % (
venv._path, p))
env.AlwaysBuild(cmd)
env.Depends(cmd, venv)
return cmd
def PyTestSuite(env, target, source, venv=None):
if 'BUILD_ONLY' in env['ENV']:
return target
for test in source:
log = test + '.log'
if venv:
try:
env['_venv'][log] = venv[0]
except KeyError:
env['_venv'] = {log: venv[0]}
cmd = env.Command(log, test, RunUnitTest)
if venv:
env.Depends(cmd, venv)
env.AlwaysBuild(cmd)
env.Alias(target, cmd)
return target
def UnitTest(env, name, sources, **kwargs):
test_env = env.Clone()
# Do not link with tcmalloc when running under valgrind/coverage env.
if sys.platform not in ['darwin', 'win32'] and env.get('OPT') != 'coverage' and \
not env['ENV'].has_key('NO_HEAPCHECK') and env.get('OPT') != 'valgrind':
test_env.Append(LIBPATH = '#/build/lib')
test_env.Append(LIBS = ['tcmalloc'])
test_exe_list = test_env.Program(name, sources)
if test_env.PlatformExclude(**kwargs):
for t in test_exe_list: t.attributes.skip_run = True
return test_exe_list
# Returns True if the build is being done by a CI job,
# by Jenkins, or some other official or automated build
def IsAutomatedBuild():
return 'ZUUL_CHANGES' in os.environ or 'BUILD_BRANCH' in os.environ
# Return True if we want quiet/short CLI echo for gcc/g++/gld/etc
# Default is same as IsAutomatedBuild(), but we return
# false if BUILD_QUIET is set to something that looks like "true"
def WantQuietOutput():
v = os.environ.get('BUILD_QUIET', IsAutomatedBuild())
return v in [ True, "True", "TRUE", "true", "yes", "1" ]
# we are not interested in source files for the dependency, but rather
# to force rebuilds. Pass an empty source to the env.Command, to break
# circular dependencies.
# XXX: This should be rewritten using SCons Value nodes (for generating
# build info itself) and Builder for managing targets.
def GenerateBuildInfoCode(env, target, source, path):
o = env.Command(target=target, source=[], action=BuildInfoAction)
# if we are running under CI or jenkins-driven CB/OB build,
# we do NOT want to use AlwaysBuild, as it triggers unnecessary
# rebuilds.
if not IsAutomatedBuild(): env.AlwaysBuild(o)
return
# If contrail-controller (i.e., #controller/) is present, determine
# git hash of head and get base version from version.info, else use
# hard-coded values.
#
def GetBuildVersion(env):
# Fetch git version
controller_path = env.Dir('#controller').path
if os.path.exists(controller_path):
p = subprocess.Popen('cd %s && git rev-parse --short HEAD' % controller_path,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
shell='True')
git_hash, err = p.communicate()
git_hash = git_hash.strip()
else:
# Or should we look for vrouter, tools/build, or ??
git_hash = 'noctrlr'
# Fetch build version
file_path = env.File('#/controller/src/base/version.info').abspath
if os.path.exists(file_path):
f = open(file_path)
base_ver = (f.readline()).strip()
else:
base_ver = "3.0"
return git_hash, base_ver
def GetBuildInfoData(env, target, source):
try:
build_user = os.environ['USER']
except KeyError:
build_user = "unknown"
try:
build_host = env['HOSTNAME']
except KeyError:
build_host = "unknown"
# Fetch Time in UTC
import datetime
build_time = str(datetime.datetime.utcnow())
build_git_info, build_version = GetBuildVersion(env)
# build json string containing build information
info = {
'build-version': build_version,
'build-time': build_time,
'build-user': build_user,
'build-hostname': build_host
}
return json.dumps({'build-info': [info]})
def BuildInfoAction(env, target, source):
build_dir = target[0].dir.path
jsdata = GetBuildInfoData(env, target, source)
h_code = """
/*
* Autogenerated file. DO NOT EDIT
*/
#ifndef ctrlplane_buildinfo_h
#define ctrlplane_buildinfo_h
#include <string>
extern const std::string BuildInfo;
#endif // ctrlplane_buildinfo_h"
"""
cc_code = """
/*
* Autogenerated file. DO NOT EDIT.
*/
#include "buildinfo.h"
const std::string BuildInfo = "%(json)s";
""" % { 'json': jsdata.replace('"', "\\\"") }
with open(os.path.join(build_dir, 'buildinfo.h'), 'w') as h_file:
h_file.write(h_code)
with open(os.path.join(build_dir, 'buildinfo.cc'), 'w') as cc_file:
cc_file.write(cc_code)
#end BuildInfoAction
def GenerateBuildInfoCCode(env, target, source, path):
build_dir = path
jsdata = GetBuildInfoData(env, target, source)
c_code = """
/*
* Autogenerated file. DO NOT EDIT.
*/
const char *ContrailBuildInfo = "%(json)s";
""" % { 'json': jsdata.replace('"', "\\\"") }
with open(os.path.join(build_dir, target[0]), 'w') as c_file:
c_file.write(c_code)
#end GenerateBuildInfoCCode
def GenerateBuildInfoPyCode(env, target, source, path):
import os
import subprocess
try:
build_user = getpass.getuser()
except KeyError:
build_user = "unknown"
try:
build_host = env['HOSTNAME']
except KeyError:
build_host = "unknown"
# Fetch Time in UTC
import datetime
build_time = unicode(datetime.datetime.utcnow())
build_git_info, build_version = GetBuildVersion(env)
# build json string containing build information
build_info = "{\\\"build-info\\\" : [{\\\"build-version\\\" : \\\"" + str(build_version) + "\\\", \\\"build-time\\\" : \\\"" + str(build_time) + "\\\", \\\"build-user\\\" : \\\"" + build_user + "\\\", \\\"build-hostname\\\" : \\\"" + build_host + "\\\", "
py_code ="build_info = \""+ build_info + "\";\n"
py_file = file(path + '/buildinfo.py', 'w')
py_file.write(py_code)
py_file.close()
return target
#end GenerateBuildInfoPyCode
def Basename(path):
return path.rsplit('.', 1)[0]
# ExtractCpp Method
def ExtractCppFunc(env, filelist):
CppSrcs = []
for target in filelist:
fname = str(target)
ext = fname.rsplit('.', 1)[1]
if ext == 'cpp' or ext == 'cc':
CppSrcs.append(fname)
return CppSrcs
# ExtractC Method
def ExtractCFunc(env, filelist):
CSrcs = []
for target in filelist:
fname = str(target)
ext = fname.rsplit('.', 1)[1]
if ext == 'c':
CSrcs.append(fname)
return CSrcs
# ExtractHeader Method
def ExtractHeaderFunc(env, filelist):
Headers = []
for target in filelist:
fname = str(target)
ext = fname.rsplit('.', 1)[1]
if ext == 'h':
Headers.append(fname)
return Headers
# ProtocDesc Methods
def ProtocDescBuilder(target, source, env):
if not env.Detect('protoc'):
raise SCons.Errors.StopError(
'protoc Compiler not detected on system')
protoc = env.WhereIs('protoc')
protoc_cmd = protoc + ' --descriptor_set_out=' + \
str(target[0]) + ' --include_imports ' + \
' --proto_path=controller/src/' + \
' --proto_path=/usr/include/ ' + \
' --proto_path=src/contrail-analytics/contrail-collector/ ' + \
str(source[0])
print(protoc_cmd)
code = subprocess.call(protoc_cmd, shell=True)
if code != 0:
raise SCons.Errors.StopError(
'protobuf desc generation failed')
def ProtocSconsEnvDescFunc(env):
descbuild = Builder(action = ProtocDescBuilder)
env.Append(BUILDERS = {'ProtocDesc' : descbuild})
def ProtocGenDescFunc(env, file):
ProtocSconsEnvDescFunc(env)
suffixes = ['.desc']
basename = Basename(file)
targets = map(lambda suffix: basename + suffix, suffixes)
return env.ProtocDesc(targets, file)
# ProtocCpp Methods
def ProtocCppBuilder(target, source, env):
spath = str(source[0]).rsplit('/',1)[0] + "/"
if not env.Detect('protoc'):
raise SCons.Errors.StopError(
'protoc Compiler not detected on system')
protoc = env.WhereIs('protoc')
protoc_cmd = protoc + ' --proto_path=/usr/include/ ' + \
' --proto_path=src/contrail-analytics/contrail-collector/ ' + \
'--proto_path=controller/src/ --proto_path=' + \
spath + ' --cpp_out=' + str(env.Dir(env['TOP'])) + \
env['PROTOC_MAP_TGT_DIR'] + ' ' + \
str(source[0])
print(protoc_cmd)
code = subprocess.call(protoc_cmd, shell=True)
if code != 0:
raise SCons.Errors.StopError(
'protobuf code generation failed')
def ProtocSconsEnvCppFunc(env):
cppbuild = Builder(action = ProtocCppBuilder)
env.Append(BUILDERS = {'ProtocCpp' : cppbuild})
def ProtocGenCppMapTgtDirFunc(env, file, target_root = ''):
if target_root == '':
env['PROTOC_MAP_TGT_DIR'] = ''
else:
env['PROTOC_MAP_TGT_DIR'] = '/' + target_root
ProtocSconsEnvCppFunc(env)
suffixes = ['.pb.h',
'.pb.cc'
]
basename = Basename(file)
targets = map(lambda suffix: basename + suffix, suffixes)
return env.ProtocCpp(targets, file)
def ProtocGenCppFunc(env, file):
return (ProtocGenCppMapTgtDirFunc(env, file, ''))
# When doing parallel build, scons will sometimes try to invoke the
# sandesh compiler while sandesh itself is still being compiled and
# linked. This results in a 'text file busy' error, and the build
# aborts.
# To avoid this, a 'wait for it' loop... we run 'sandesh -version',
# and sleep for one sec before retry if it fails.
#
# This is a terrible hack, and should be fixed, but all attempts to
# get scons to recognize the dependency on the sandesh compailer have
# so far been fruitless.
#
def wait_for_sandesh_install(env):
rc = 0
while (rc != 1):
with open(os.devnull, "w") as f:
try:
rc = subprocess.call([env['SANDESH'], '-version'], stdout=f, stderr=f)
except Exception as e:
rc = 0
if (rc != 1):
print('scons: warning: sandesh -version returned %d, retrying' % rc)
time.sleep(1)
class SandeshWarning(SCons.Warnings.Warning):
pass
class SandeshCodeGeneratorError(SandeshWarning):
pass
# SandeshGenDoc Methods
def SandeshDocBuilder(target, source, env):
opath = target[0].dir.path
wait_for_sandesh_install(env)
code = subprocess.call(env['SANDESH'] + ' --gen doc -I controller/src/ -I src/contrail-common -out '
+ opath + " " + source[0].path, shell=True)
if code != 0:
raise SCons.Errors.StopError(SandeshCodeGeneratorError,
'SandeshDoc documentation generation failed')
def SandeshSconsEnvDocFunc(env):
docbuild = Builder(action = Action(SandeshDocBuilder, 'SandeshDocBuilder $SOURCE -> $TARGETS'))
env.Append(BUILDERS = {'SandeshDoc' : docbuild})
def SandeshGenDocFunc(env, filepath, target=''):
SandeshSconsEnvDocFunc(env)
suffixes = ['.html',
'_index.html',
'_logs.html',
'_logs.doc.schema.json',
'_logs.emerg.html',
'_logs.emerg.doc.schema.json',
'_logs.alert.html',
'_logs.alert.doc.schema.json',
'_logs.crit.html',
'_logs.crit.doc.schema.json',
'_logs.error.html',
'_logs.error.doc.schema.json',
'_logs.warn.html',
'_logs.warn.doc.schema.json',
'_logs.notice.html',
'_logs.notice.doc.schema.json',
'_logs.info.html',
'_logs.info.doc.schema.json',
'_logs.debug.html',
'_logs.debug.doc.schema.json',
'_logs.invalid.html',
'_logs.invalid.doc.schema.json',
'_uves.html',
'_uves.doc.schema.json',
'_traces.html',
'_traces.doc.schema.json',
'_introspect.html',
'_introspect.doc.schema.json',
'_stats_tables.json']
basename = Basename(filepath)
path_split = basename.rsplit('/', 1)
if len(path_split) == 2:
filename = path_split[1]
else:
filename = path_split[0]
targets = [target + 'gen-doc/' + filename + suffix for suffix in suffixes]
env.Depends(targets, '#build/bin/sandesh' + env['PROGSUFFIX'])
return env.SandeshDoc(targets, filepath)
# SandeshGenOnlyCpp Methods
def SandeshOnlyCppBuilder(target, source, env):
sname = os.path.splitext(source[0].name)[0] # file name w/o .sandesh
html_cpp_name = os.path.join(target[0].dir.path, sname + '_html.cpp')
wait_for_sandesh_install(env)
code = subprocess.call(env['SANDESH'] + ' --gen cpp -I controller/src/ -I src/contrail-common -out ' +
target[0].dir.path + " " + source[0].path, shell=True)
if code != 0:
raise SCons.Errors.StopError(SandeshCodeGeneratorError,
'SandeshOnlyCpp code generation failed')
with open(html_cpp_name, 'a') as html_cpp_file:
html_cpp_file.write('int ' + sname + '_marker = 0;\n')
def SandeshSconsEnvOnlyCppFunc(env):
onlycppbuild = Builder(action = Action(SandeshOnlyCppBuilder,'SandeshOnlyCppBuilder $SOURCE -> $TARGETS'))
env.Append(BUILDERS = {'SandeshOnlyCpp' : onlycppbuild})
def SandeshGenOnlyCppFunc(env, file, extra_suffixes=[]):
SandeshSconsEnvOnlyCppFunc(env)
suffixes = ['_types.h',
'_types.cpp',
'_constants.h',
'_constants.cpp',
'_html.cpp']
if extra_suffixes:
if isinstance(extra_suffixes, basestring):
extra_suffixes = [ extra_suffixes ]
suffixes += extra_suffixes
basename = Basename(file)
targets = [basename + suffix for suffix in suffixes]
env.Depends(targets, '#build/bin/sandesh' + env['PROGSUFFIX'])
return env.SandeshOnlyCpp(targets, file)
# SandeshGenCpp Methods
def SandeshCppBuilder(target, source, env):
opath = target[0].dir.path
sname = os.path.join(opath, os.path.splitext(source[0].name)[0])
wait_for_sandesh_install(env)
code = subprocess.call(env['SANDESH'] + ' --gen cpp --gen html -I controller/src/ -I src/contrail-common -out '
+ opath + " " + source[0].path, shell=True)
if code != 0:
raise SCons.Errors.StopError(SandeshCodeGeneratorError,
'SandeshCpp code generation failed')
tname = sname + "_html_template.cpp"
hname = os.path.basename(sname + ".xml")
cname = sname + "_html.cpp"
if not env.Detect('xxd'):
raise SCons.Errors.StopError(SandeshCodeGeneratorError,
'xxd not detected on system')
with open(cname, 'w') as cfile:
cfile.write('namespace {\n')
# If one passes file to `stdout` kwarg to subprocess.call on Windows, it gets fileno from this
# file, then handle for that fileno and forwards stdout to that handle, which means it bypasses
# Python's internal buffer and sometimes writes before our previous call to `write` method.
# Besides, probably due to some bug in subprocess on Windows, it opens handles to other files in
# that folder (checked with handle64 from Windows Sysinternals) so it sometimes breaks
# multithreaded builds when it opens a handle to file used by another thread. For that reason we
# can't use `stdout` kwarg here. If there's a need to get rid of shell redirection, one should
# get rid of calling xxd at all - this feature should be done in native Python code.
subprocess.call('xxd -i ' + hname + ' >> ' + os.path.basename(cname), shell=True, cwd=opath)
with open(cname, 'a') as cfile:
cfile.write('}\n')
with open(tname, 'r') as tfile:
for line in tfile:
cfile.write(line)
def SandeshSconsEnvCppFunc(env):
cppbuild = Builder(action = Action(SandeshCppBuilder, 'SandeshCppBuilder $SOURCE -> $TARGETS'))
env.Append(BUILDERS = {'SandeshCpp' : cppbuild})
def SandeshGenCppFunc(env, file, extra_suffixes=[]):
SandeshSconsEnvCppFunc(env)
suffixes = ['_types.h',
'_types.cpp',
'_constants.h',
'_constants.cpp',
'_html.cpp']
if extra_suffixes:
if isinstance(extra_suffixes, basestring):
extra_suffixes = [ extra_suffixes ]
suffixes += extra_suffixes
basename = Basename(file)
targets = [basename + suffix for suffix in suffixes]
env.Depends(targets, '#build/bin/sandesh' + env['PROGSUFFIX'])
return env.SandeshCpp(targets, file)
# SandeshGenC Methods
def SandeshCBuilder(target, source, env):
# We need to trim the /gen-c/ out of the target path
opath = os.path.dirname(target[0].dir.path)
wait_for_sandesh_install(env)
code = subprocess.call(env['SANDESH'] + ' --gen c -o ' + opath +
' ' + source[0].path, shell=True)
if code != 0:
raise SCons.Errors.StopError(SandeshCodeGeneratorError,
'SandeshC code generation failed')
def SandeshSconsEnvCFunc(env):
cbuild = Builder(action = Action(SandeshCBuilder, 'SandeshCBuilder $SOURCE -> $TARGETS'))
env.Append(BUILDERS = {'SandeshC' : cbuild})
def SandeshGenCFunc(env, file):
SandeshSconsEnvCFunc(env)
suffixes = ['_types.h', '_types.c']
basename = Basename(file)
targets = ['gen-c/' + basename + suffix for suffix in suffixes]
env.Depends(targets, '#build/bin/sandesh' + env['PROGSUFFIX'])
return env.SandeshC(targets, file)
# SandeshGenPy Methods
def SandeshPyBuilder(target, source, env):
opath = target[0].dir.path
py_opath = os.path.dirname(opath)
wait_for_sandesh_install(env)
code = subprocess.call(env['SANDESH'] + ' --gen py:new_style -I controller/src/ -I src/contrail-common -out ' +
py_opath + " " + source[0].path, shell=True)
if code != 0:
raise SCons.Errors.StopError(SandeshCodeGeneratorError,
'SandeshPy py code generation failed')
code = subprocess.call(env['SANDESH'] + ' --gen html -I controller/src/ -I src/contrail-common -out ' +
opath + " " + source[0].path, shell=True)
if code != 0:
raise SCons.Errors.StopError(SandeshCodeGeneratorError,
'SandeshPy html generation failed')
def SandeshSconsEnvPyFunc(env):
pybuild = Builder(action = Action(SandeshPyBuilder,'SandeshPyBuilder $SOURCE -> $TARGETS'))
env.Append(BUILDERS = {'SandeshPy' : pybuild})
def SandeshGenPyFunc(env, path, target='', gen_py=True):
SandeshSconsEnvPyFunc(env)
modules = [
'__init__.py',
'constants.py',
'ttypes.py',
'http_request.py']
basename = Basename(path)
path_split = basename.rsplit('/',1)
if len(path_split) == 2:
mod_dir = path_split[1] + '/'
else:
mod_dir = path_split[0] + '/'
if gen_py:
targets = [target + 'gen_py/' + mod_dir + module for module in modules]
else:
targets = [target + mod_dir + module for module in modules]
env.Depends(targets, '#build/bin/sandesh' + env['PROGSUFFIX'])
return env.SandeshPy(targets, path)
# Golang Methods for CNI
def GoCniFunc(env, filepath, target=''):
# get dependencies
goenv = os.environ.copy()
goenv['GOROOT'] = env.Dir('#/third_party/go').abspath
goenv['GOPATH'] = env.Dir('#/third_party/cni_go_deps').abspath
goenv['GOBIN'] = env.Dir(env['TOP'] + '/container/cni/bin').abspath
cni_path = env.Dir('#/' + env.Dir('.').srcnode().path).abspath
go_cmd = goenv['GOROOT'] + '/bin/go '
try:
cmd = 'cd ' + cni_path + ';'
cmd += go_cmd + 'install'
code = subprocess.call(cmd, shell=True, env=goenv)
except Exception as e:
print(str(e))
return env['TOP'] + '/container/cni/bin/' + filepath
# ThriftGenCpp Methods
ThriftServiceRe = re.compile(r'service\s+(\S+)\s*{', re.M)
def ThriftServicesFunc(node):
contents = node.get_text_contents()
return ThriftServiceRe.findall(contents)
def ThriftSconsEnvFunc(env, async):
opath = env.Dir('.').abspath
thriftcmd = os.path.join(env.Dir(env['TOP_BIN']).abspath, 'thrift')
if async:
lstr = thriftcmd + ' --gen cpp:async -o ' + opath + ' $SOURCE'
else:
lstr = thriftcmd + ' --gen cpp -o ' + opath + ' $SOURCE'
cppbuild = Builder(action = lstr)
env.Append(BUILDERS = {'ThriftCpp' : cppbuild})
def ThriftGenCppFunc(env, file, async):
ThriftSconsEnvFunc(env, async)
suffixes = ['_types.h', '_constants.h', '_types.cpp', '_constants.cpp']
basename = Basename(file)
base_files = map(lambda s: 'gen-cpp/' + basename + s, suffixes)
services = ThriftServicesFunc(env.File(file))
service_cfiles = map(lambda s: 'gen-cpp/' + s + '.cpp', services)
service_hfiles = map(lambda s: 'gen-cpp/' + s + '.h', services)
targets = base_files + service_cfiles + service_hfiles
env.Depends(targets, '#build/bin/thrift' + env['PROGSUFFIX'])
return env.ThriftCpp(targets, file)
def ThriftPyBuilder(source, target, env, for_signature):
output_dir = os.path.dirname(os.path.dirname(str(target[0])))
return ('%s --gen py:new_style,utf8strings -I src/ -out %s %s' %
(os.path.join(env.Dir(env['TOP_BIN']).abspath, 'thrift'), output_dir, source[0]))
def ThriftSconsEnvPyFunc(env):
pybuild = Builder(generator = ThriftPyBuilder)
env.Append(BUILDERS = {'ThriftPy' : pybuild})
def ThriftGenPyFunc(env, path, target=''):
modules = [
'__init__.py',
'constants.py',
'ttypes.py']
basename = Basename(path)
path_split = basename.rsplit('/', 1)
if len(path_split) == 2:
mod_dir = path_split[1] + '/'
else:
mod_dir = path_split[0] + '/'
if target[-1] != '/':
target += '/'
targets = map(lambda module: target + 'gen_py/' + mod_dir + module, modules)
env.Depends(targets, '#build/bin/thrift' + env['PROGSUFFIX'])
return env.ThriftPy(targets, path)
def IFMapBuilderCmd(source, target, env, for_signature):
output = Basename(source[0].abspath)
return '%s -f -g ifmap-backend -o %s %s' % (env.File('#src/contrail-api-client/generateds/generateDS.py').abspath, output, source[0])
def IFMapTargetGen(target, source, env):
suffixes = ['_types.h', '_types.cc', '_parser.cc',
'_server.cc', '_agent.cc']
basename = Basename(source[0].abspath)
targets = [basename + x for x in suffixes]
return targets, source
def CreateIFMapBuilder(env):
builder = Builder(generator = IFMapBuilderCmd,
src_suffix = '.xsd',
emitter = IFMapTargetGen)
env.Append(BUILDERS = { 'IFMapAutogen' : builder})
def DeviceAPIBuilderCmd(source, target, env, for_signature):
output = Basename(source[0].abspath)
return './src/contrail-api-client/generateds/generateDS.py -f -g device-api -o %s %s' % (output, source[0])
def DeviceAPITargetGen(target, source, env):
suffixes = []
basename = Basename(source[0].abspath)
targets = map(lambda x: basename + x, suffixes)
return targets, source
def CreateDeviceAPIBuilder(env):
builder = Builder(generator = DeviceAPIBuilderCmd,
src_suffix = '.xsd')
env.Append(BUILDERS = { 'DeviceAPIAutogen' : builder})
def TypeBuilderCmd(source, target, env, for_signature):
output = Basename(source[0].abspath)
return '%s -f -g type -o %s %s' % (env.File('#src/contrail-api-client/generateds/generateDS.py').abspath, output, source[0])
def TypeTargetGen(target, source, env):
suffixes = ['_types.h', '_types.cc', '_parser.cc']
basename = Basename(source[0].abspath)
targets = [basename + x for x in suffixes]
return targets, source
def CreateTypeBuilder(env):
builder = Builder(generator = TypeBuilderCmd,
src_suffix = '.xsd',
emitter = TypeTargetGen)
env.Append(BUILDERS = { 'TypeAutogen' : builder})
# Check for unsupported/buggy compilers.
def CheckBuildConfiguration(conf):
# gcc 4.7.0 generates buggy code when optimization is turned on.
opt_level = GetOption('opt')
if ((opt_level == 'production' or opt_level == 'profile') and \
(conf.env['CC'].endswith("gcc") or conf.env['CC'].endswith("g++"))):
if conf.env['CCVERSION'] == "4.7.0":
print("Unsupported/Buggy compiler gcc 4.7.0 for building " + \
"optimized binaries")
raise convert_to_BuildError(1)
return conf.Finish()
def PyTestSuiteCov(target, source, env):
for test in source:
log = test.name + '.log'
if env['env_venv']:
venv = env['env_venv']
try: