Fix pydoctor invocation.
[samba.git] / wscript
1 #!/usr/bin/env python
2
3 srcdir = '.'
4 blddir = 'bin'
5
6 APPNAME='samba'
7 VERSION=None
8
9 import sys, os, tempfile
10 sys.path.insert(0, srcdir+"/buildtools/wafsamba")
11 import wafsamba, Options, samba_dist, Scripting, Utils, samba_version
12
13
14 samba_dist.DIST_DIRS('.')
15 samba_dist.DIST_BLACKLIST('.gitignore .bzrignore source4/selftest/provisions')
16
17 # install in /usr/local/samba by default
18 Options.default_prefix = '/usr/local/samba'
19
20 # This callback optionally takes a list of paths as arguments:
21 # --with-system_mitkrb5 /path/to/krb5 /another/path
22 def system_mitkrb5_callback(option, opt, value, parser):
23     setattr(parser.values, option.dest, True)
24     value = []
25     for arg in parser.rargs:
26         # stop on --foo like options
27         if arg[:2] == "--" and len(arg) > 2:
28             break
29         value.append(arg)
30     if len(value)>0:
31         del parser.rargs[:len(value)]
32         setattr(parser.values, option.dest, value)
33
34 def set_options(opt):
35     opt.BUILTIN_DEFAULT('NONE')
36     opt.PRIVATE_EXTENSION_DEFAULT('samba4')
37     opt.RECURSE('lib/replace')
38     opt.RECURSE('dynconfig')
39     opt.RECURSE('lib/ldb')
40     opt.RECURSE('lib/ntdb')
41     opt.RECURSE('selftest')
42     opt.RECURSE('source4/lib/tls')
43     opt.RECURSE('pidl')
44     opt.RECURSE('source3')
45     opt.RECURSE('lib/util')
46     opt.RECURSE('ctdb')
47
48     opt.add_option('--with-system-mitkrb5',
49                    help='enable system MIT krb5 build (includes Samba 4 client and Samba 3 code base).'+
50                         'You may specify list of paths where Kerberos is installed (e.g. /usr/local /usr/kerberos) to search krb5-config',
51                    action='callback', callback=system_mitkrb5_callback, dest='with_system_mitkrb5', default=False)
52
53     opt.add_option('--without-ad-dc',
54                    help='disable AD DC functionality (enables Samba 4 client and Samba 3 code base).',
55                    action='store_true', dest='without_ad_dc', default=False)
56
57     opt.add_option('--with-pie',
58                   help=("Build Position Independent Executables " +
59                         "(default if supported by compiler)"),
60                   action="store_true", dest='enable_pie')
61     opt.add_option('--without-pie',
62                   help=("Disable Position Independent Executable builds"),
63                   action="store_false", dest='enable_pie')
64
65     opt.add_option('--with-relro',
66                   help=("Build with full RELocation Read-Only (RELRO)" +
67                         "(default if supported by compiler)"),
68                   action="store_true", dest='enable_relro')
69     opt.add_option('--without-relro',
70                   help=("Disable RELRO builds"),
71                   action="store_false", dest='enable_relro')
72
73     opt.add_option('--with-systemd',
74                    help=("Enable systemd integration"),
75                    action='store_true', dest='enable_systemd')
76
77     opt.add_option('--without-systemd',
78                    help=("Disable systemd integration"),
79                    action='store_false', dest='enable_systemd')
80
81     gr = opt.option_group('developer options')
82
83     opt.tool_options('python') # options for disabling pyc or pyo compilation
84     # enable options related to building python extensions
85
86
87 def configure(conf):
88     version = samba_version.load_version(env=conf.env)
89
90     conf.DEFINE('CONFIG_H_IS_FROM_SAMBA', 1)
91     conf.DEFINE('_SAMBA_BUILD_', version.MAJOR, add_to_cflags=True)
92     conf.DEFINE('HAVE_CONFIG_H', 1, add_to_cflags=True)
93
94     if Options.options.developer:
95         conf.ADD_CFLAGS('-DDEVELOPER -DDEBUG_PASSWORD')
96         conf.env.DEVELOPER = True
97
98     conf.ADD_EXTRA_INCLUDES('#include/public #source4 #lib #source4/lib #source4/include #include #lib/replace')
99
100     conf.env.replace_add_global_pthread = True
101     conf.RECURSE('lib/replace')
102
103     conf.SAMBA_CHECK_PERL(mandatory=True)
104     conf.find_program('xsltproc', var='XSLTPROC')
105
106     conf.SAMBA_CHECK_PYTHON(mandatory=True, version=(2,5,0))
107     conf.SAMBA_CHECK_PYTHON_HEADERS(mandatory=True)
108
109     if sys.platform == 'darwin' and not conf.env['HAVE_ENVIRON_DECL']:
110         # Mac OSX needs to have this and it's also needed that the python is compiled with this
111         # otherwise you face errors about common symbols
112         if not conf.CHECK_SHLIB_W_PYTHON("Checking if -fno-common is needed"):
113             conf.ADD_CFLAGS('-fno-common')
114         if not conf.CHECK_SHLIB_W_PYTHON("Checking if -undefined dynamic_lookup is not need"):
115             conf.env.append_value('shlib_LINKFLAGS', ['-undefined', 'dynamic_lookup'])
116
117     if sys.platform == 'darwin':
118         conf.ADD_LDFLAGS('-framework CoreFoundation')
119
120     if int(conf.env['PYTHON_VERSION'][0]) >= 3:
121         raise Utils.WafError('Python version 3.x is not supported by Samba yet')
122
123     conf.RECURSE('dynconfig')
124
125     if conf.CHECK_FOR_THIRD_PARTY():
126         conf.RECURSE('third_party/zlib')
127         conf.RECURSE('third_party/popt')
128     else:
129         if not conf.CHECK_ZLIB():
130             raise Utils.WafError('zlib development packages have not been found.\nIf third_party is installed, check that it is in the proper place.')
131         else:
132             conf.define('USING_SYSTEM_ZLIB',1)
133
134         if not conf.CHECK_POPT():
135             raise Utils.WafError('popt development packages have not been found.\nIf third_party is installed, check that it is in the proper place.')
136         else:
137             conf.define('USING_SYSTEM_POPT', 1)
138
139     conf.RECURSE('lib/ldb')
140
141     if Options.options.with_system_mitkrb5:
142         conf.PROCESS_SEPARATE_RULE('system_mitkrb5')
143     if not (Options.options.without_ad_dc or Options.options.with_system_mitkrb5):
144         conf.DEFINE('AD_DC_BUILD_IS_ENABLED', 1)
145     # Only process heimdal_build for non-MIT KRB5 builds
146     # When MIT KRB5 checks are done as above, conf.env.KRB5_VENDOR will be set
147     # to the lowcased output of 'krb5-config --vendor'.
148     # If it is not set or the output is 'heimdal', we are dealing with
149     # system-provided or embedded Heimdal build
150     if conf.CONFIG_GET('KRB5_VENDOR') in (None, 'heimdal'):
151         conf.RECURSE('source4/heimdal_build')
152     conf.RECURSE('source4/lib/tls')
153     conf.RECURSE('source4/ntvfs/sysdep')
154     conf.RECURSE('lib/util')
155     conf.RECURSE('lib/ccan')
156     conf.RECURSE('lib/ntdb')
157     conf.RECURSE('lib/util/charset')
158     conf.RECURSE('source4/auth')
159     conf.RECURSE('lib/nss_wrapper')
160     conf.RECURSE('nsswitch')
161     conf.RECURSE('lib/socket_wrapper')
162     conf.RECURSE('lib/uid_wrapper')
163     conf.RECURSE('lib/subunit/c')
164     conf.RECURSE('libcli/smbreadline')
165     conf.RECURSE('lib/crypto')
166     conf.RECURSE('pidl')
167     conf.RECURSE('selftest')
168     conf.RECURSE('source3')
169     conf.RECURSE('lib/texpect')
170     if Options.options.with_cluster_support:
171         conf.env.with_ctdb = True
172         conf.RECURSE('ctdb')
173
174     conf.SAMBA_CHECK_UNDEFINED_SYMBOL_FLAGS()
175
176     # gentoo always adds this. We want our normal build to be as
177     # strict as the strictest OS we support, so adding this here
178     # allows us to find problems on our development hosts faster.
179     # It also results in faster load time.
180
181     if not sys.platform.startswith("openbsd"):
182         conf.env.asneeded_ldflags = conf.ADD_LDFLAGS('-Wl,--as-needed', testflags=True)
183
184     if not conf.CHECK_NEED_LC("-lc not needed"):
185         conf.ADD_LDFLAGS('-lc', testflags=False)
186
187     # we don't want PYTHONDIR in config.h, as otherwise changing
188     # --prefix causes a complete rebuild
189     del(conf.env.defines['PYTHONDIR'])
190     del(conf.env.defines['PYTHONARCHDIR'])
191
192     if not conf.CHECK_CODE('#include "tests/summary.c"',
193                            define='SUMMARY_PASSES',
194                            addmain=False,
195                            msg='Checking configure summary'):
196         raise Utils.WafError('configure summary failed')
197
198     if Options.options.enable_pie != False:
199         if Options.options.enable_pie == True:
200                 need_pie = True
201         else:
202                 # not specified, only build PIEs if supported by compiler
203                 need_pie = False
204         if conf.check_cc(cflags='-fPIE', ldflags='-pie', mandatory=need_pie,
205                          msg="Checking compiler for PIE support"):
206                 conf.env['ENABLE_PIE'] = True
207
208     if Options.options.enable_relro != False:
209         if Options.options.enable_relro == True:
210             need_relro = True
211         else:
212             # not specified, only build RELROs if supported by compiler
213             need_relro = False
214         if conf.check_cc(cflags='', ldflags='-Wl,-z,relro,-z,now', mandatory=need_relro,
215                          msg="Checking compiler for full RELRO support"):
216             conf.env['ENABLE_RELRO'] = True
217
218     if Options.options.enable_systemd != False:
219         conf.check_cfg(package='libsystemd-daemon', args='--cflags --libs',
220                        msg='Checking for libsystemd-daemon', uselib_store="SYSTEMD-DAEMON")
221         conf.CHECK_HEADERS('systemd/sd-daemon.h', lib='systemd-daemon')
222         conf.CHECK_LIB('systemd-daemon', shlib=True)
223
224     if (conf.CONFIG_SET('HAVE_SYSTEMD_SD_DAEMON_H') and
225         conf.CONFIG_SET('HAVE_LIBSYSTEMD_DAEMON')):
226         conf.DEFINE('HAVE_SYSTEMD', '1')
227         conf.env['ENABLE_SYSTEMD'] = True
228     else:
229         conf.SET_TARGET_TYPE('systemd-daemon', 'EMPTY')
230         conf.undefine('HAVE_SYSTEMD')
231
232     conf.SAMBA_CONFIG_H('include/config.h')
233
234 def etags(ctx):
235     '''build TAGS file using etags'''
236     import Utils
237     source_root = os.path.dirname(Utils.g_module.root_path)
238     cmd = 'rm -f %s/TAGS && (find %s -name "*.[ch]" | egrep -v \.inst\. | xargs -n 100 etags -a)' % (source_root, source_root)
239     print("Running: %s" % cmd)
240     status = os.system(cmd)
241     if os.WEXITSTATUS(status):
242         raise Utils.WafError('etags failed')
243
244 def ctags(ctx):
245     "build 'tags' file using ctags"
246     import Utils
247     source_root = os.path.dirname(Utils.g_module.root_path)
248     cmd = 'ctags --python-kinds=-i $(find %s -name "*.[ch]" | grep -v "*_proto\.h" | egrep -v \.inst\.) $(find %s -name "*.py")' % (source_root, source_root)
249     print("Running: %s" % cmd)
250     status = os.system(cmd)
251     if os.WEXITSTATUS(status):
252         raise Utils.WafError('ctags failed')
253
254 # putting this here enabled build in the list
255 # of commands in --help
256 def build(bld):
257     '''build all targets'''
258     samba_version.load_version(env=bld.env, is_install=bld.is_install)
259     pass
260
261
262 def pydoctor(ctx):
263     '''build python apidocs'''
264     bp = os.path.abspath('bin/python')
265     mpaths = {}
266     modules = ['talloc', 'tdb', 'ldb', 'ntdb']
267     for m in modules:
268         f = os.popen("PYTHONPATH=%s python -c 'import %s; print %s.__file__'" % (bp, m, m), 'r')
269         try:
270             mpaths[m] = f.read().strip()
271         finally:
272             f.close()
273     mpaths['main'] = bp
274     cmd = ('PYTHONPATH=%(main)s pydoctor --introspect-c-modules --project-name=Samba '
275            '--project-url=http://www.samba.org --make-html --docformat=restructuredtext '
276            '--add-package bin/python/samba ' + ''.join('--add-module %s ' % n for n in modules))
277     cmd = cmd % mpaths
278     print("Running: %s" % cmd)
279     status = os.system(cmd)
280     if os.WEXITSTATUS(status):
281         raise Utils.WafError('pydoctor failed')
282
283
284 def pep8(ctx):
285     '''run pep8 validator'''
286     cmd='PYTHONPATH=bin/python pep8 -r bin/python/samba'
287     print("Running: %s" % cmd)
288     status = os.system(cmd)
289     if os.WEXITSTATUS(status):
290         raise Utils.WafError('pep8 failed')
291
292
293 def wafdocs(ctx):
294     '''build wafsamba apidocs'''
295     from samba_utils import recursive_dirlist
296     os.system('pwd')
297     list = recursive_dirlist('../buildtools/wafsamba', '.', pattern='*.py')
298
299     cmd='PYTHONPATH=bin/python pydoctor --project-name=wafsamba --project-url=http://www.samba.org --make-html --docformat=restructuredtext'
300     print(list)
301     for f in list:
302         cmd += ' --add-module %s' % f
303     print("Running: %s" % cmd)
304     status = os.system(cmd)
305     if os.WEXITSTATUS(status):
306         raise Utils.WafError('wafdocs failed')
307
308
309 def dist():
310     '''makes a tarball for distribution'''
311     sambaversion = samba_version.load_version(env=None)
312
313     os.system(srcdir + "/release-scripts/build-manpages-nogit")
314     samba_dist.DIST_FILES('bin/docs:docs', extend=True)
315
316     if sambaversion.IS_SNAPSHOT:
317         # write .distversion file and add to tar
318         if not os.path.isdir(blddir):
319             os.makedirs(blddir)
320         distversionf = tempfile.NamedTemporaryFile(mode='w', prefix='.distversion',dir=blddir)
321         for field in sambaversion.vcs_fields:
322             distveroption = field + '=' + str(sambaversion.vcs_fields[field])
323             distversionf.write(distveroption + '\n')
324         distversionf.flush()
325         samba_dist.DIST_FILES('%s:.distversion' % distversionf.name, extend=True)
326
327         samba_dist.dist()
328         distversionf.close()
329     else:
330         samba_dist.dist()
331
332
333 def distcheck():
334     '''test that distribution tarball builds and installs'''
335     samba_version.load_version(env=None)
336     import Scripting
337     d = Scripting.distcheck
338     d()
339
340 def wildcard_cmd(cmd):
341     '''called on a unknown command'''
342     from samba_wildcard import run_named_build_task
343     run_named_build_task(cmd)
344
345 def main():
346     from samba_wildcard import wildcard_main
347     wildcard_main(wildcard_cmd)
348 Scripting.main = main
349
350 def reconfigure(ctx):
351     '''reconfigure if config scripts have changed'''
352     import samba_utils
353     samba_utils.reconfigure(ctx)