def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'check_sync_criteria' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_cache_dir(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'os_name': 'ubuntu',
'os_code_name': 'trusty',
'maintainer_email': '*****@*****.**',
'maintainer_name': 'Dirk Thomas',
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': os.getuid(),
})
create_dockerfile(
'release/release_check_sync_criteria_task.Dockerfile.em',
data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'doc independent' job")
add_argument_config_url(parser)
add_argument_build_name(parser, 'doc')
add_argument_install_apt_packages(parser)
add_argument_install_pip_packages(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'install_apt_packages': args.install_apt_packages,
'install_pip_packages': args.install_pip_packages,
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': get_user_id(),
})
create_dockerfile(
'doc/doc_independent_task.Dockerfile.em', data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(description="Run the 'doc' job")
add_argument_config_url(parser)
add_argument_rosdistro_index_url(parser, required=True)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_build_tool(parser, required=True)
add_argument_vcs_information(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_custom_rosdep_urls(parser)
add_argument_force(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls':
args.distribution_repository_urls,
'distribution_repository_keys':
get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'custom_rosdep_urls':
args.custom_rosdep_urls,
'uid':
get_user_id(),
})
create_dockerfile('doc/doc_create_task.Dockerfile.em', data,
args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'devel' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_groovy_script(parser)
add_argument_dockerfile_dir(parser)
add_argument_dry_run(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': get_user_id(),
})
create_dockerfile(
'devel/devel_create_reconfigure_task.Dockerfile.em',
data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'trigger_jobs' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_missing_only(parser)
add_argument_source_only(parser)
add_argument_groovy_script(parser)
add_argument_cache_dir(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': get_user_id(),
})
create_dockerfile(
'release/release_create_trigger_task.Dockerfile.em',
data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'devel' job")
add_argument_rosdistro_index_url(parser, required=True)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_custom_rosdep_urls(parser)
parser.add_argument(
'--prerelease-overlay',
action='store_true',
help='Operate on two catkin workspaces')
add_argument_build_tool(parser, required=True)
add_argument_ros_version(parser)
add_argument_env_vars(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'custom_rosdep_urls': args.custom_rosdep_urls,
'uid': get_user_id(),
})
create_dockerfile(
'devel/devel_create_tasks.Dockerfile.em', data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_release_build_files(config, args.rosdistro_name)
build_file = build_files[args.release_build_name]
reconfigure_jobs_job_config = get_reconfigure_jobs_job_config(
args, config, build_file)
trigger_jobs_job_config = get_trigger_jobs_job_config(
args, config, build_file)
import_upstream_job_config = get_import_upstream_job_config(
args, config, build_file)
jenkins = connect(config.jenkins_url)
view = configure_view(jenkins, JENKINS_MANAGEMENT_VIEW)
group_name = get_release_view_name(
args.rosdistro_name, args.release_build_name)
job_name = '%s_%s' % (group_name, 'reconfigure-jobs')
configure_job(jenkins, job_name, reconfigure_jobs_job_config, view=view)
job_name = '%s_%s' % (group_name, 'trigger-jobs')
configure_job(jenkins, job_name, trigger_jobs_job_config, view=view)
job_name = 'import_upstream'
configure_job(jenkins, job_name, import_upstream_job_config, view=view)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'release' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_groovy_script(parser)
add_argument_dockerfile_dir(parser)
add_argument_dry_run(parser)
add_argument_package_names(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': get_user_id(),
})
create_dockerfile(
'release/release_create_reconfigure_task.Dockerfile.em',
data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'check_sync_criteria' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_cache_dir(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': get_user_id(),
})
create_dockerfile(
'release/release_check_sync_criteria_task.Dockerfile.em',
data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'doc_metadata' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_dry_run(parser)
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_doc_build_files(config, args.rosdistro_name)
build_file = build_files[args.doc_build_name]
if build_file.documentation_type != DOC_TYPE_MANIFEST:
print(("The doc build file '%s' has the wrong documentation type to " +
"be used with this script") % args.doc_build_name,
file=sys.stderr)
return 1
return configure_doc_metadata_job(args.config_url,
args.rosdistro_name,
args.doc_build_name,
config=config,
build_file=build_file,
dry_run=args.dry_run)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'doc independent' job")
add_argument_config_url(parser)
add_argument_build_name(parser, 'doc')
add_argument_install_apt_packages(parser)
add_argument_install_pip_packages(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'install_apt_packages':
args.install_apt_packages,
'install_pip_packages':
args.install_pip_packages,
'distribution_repository_urls':
args.distribution_repository_urls,
'distribution_repository_keys':
get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid':
get_user_id(),
})
create_dockerfile('doc/doc_independent_task.Dockerfile.em', data,
args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'check_sync_criteria' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_cache_dir(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': get_user_id(),
})
create_dockerfile(
'release/release_check_sync_criteria_task.Dockerfile.em',
data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'doc' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_doc_build_files(config, args.rosdistro_name)
build_file = build_files[args.doc_build_name]
if build_file.documentation_type != DOC_TYPE_ROSDOC:
print(("The doc build file '%s' has the wrong documentation type to " +
"be used with this script") % args.doc_build_name,
file=sys.stderr)
return 1
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins)
group_name = get_doc_view_name(
args.rosdistro_name, args.doc_build_name)
configure_reconfigure_jobs_job(
jenkins, group_name, args, config, build_file)
configure_trigger_jobs_job(jenkins, group_name, build_file)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'doc' job")
add_argument_config_url(parser)
add_argument_rosdistro_index_url(parser, required=True)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_vcs_information(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_force(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid': get_user_id(),
})
create_dockerfile(
'doc/doc_create_task.Dockerfile.em', data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'doc' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_dry_run(parser)
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_doc_build_files(config, args.rosdistro_name)
build_file = build_files[args.doc_build_name]
if build_file.documentation_type != DOC_TYPE_ROSDOC:
print(("The doc build file '%s' has the wrong documentation type to " +
"be used with this script") % args.doc_build_name,
file=sys.stderr)
return 1
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins, dry_run=args.dry_run)
group_name = get_doc_view_name(args.rosdistro_name, args.doc_build_name)
configure_reconfigure_jobs_job(jenkins,
group_name,
args,
config,
build_file,
dry_run=args.dry_run)
configure_trigger_jobs_job(jenkins,
group_name,
build_file,
dry_run=args.dry_run)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'devel' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_dry_run(parser)
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_source_build_files(config, args.rosdistro_name)
build_file = build_files[args.source_build_name]
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins, dry_run=args.dry_run)
group_name = get_devel_view_name(args.rosdistro_name,
args.source_build_name)
configure_reconfigure_jobs_job(jenkins,
group_name,
args,
config,
build_file,
dry_run=args.dry_run)
configure_trigger_jobs_job(jenkins,
group_name,
build_file,
dry_run=args.dry_run)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(description="Run the 'devel' job")
add_argument_rosdistro_index_url(parser, required=True)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_custom_rosdep_urls(parser)
parser.add_argument('--prerelease-overlay',
action='store_true',
help='Operate on two catkin workspaces')
add_argument_env_vars(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls':
args.distribution_repository_urls,
'distribution_repository_keys':
get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'custom_rosdep_urls':
args.custom_rosdep_urls,
'uid':
get_user_id(),
})
create_dockerfile('devel/devel_create_tasks.Dockerfile.em', data,
args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_dry_run(parser)
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_release_build_files(config, args.rosdistro_name)
build_file = build_files[args.release_build_name]
package_formats = set(
package_format_mapping[os_name] for os_name in build_file.targets.keys())
assert len(package_formats) == 1
package_format = package_formats.pop()
group_name = get_release_job_prefix(
args.rosdistro_name, args.release_build_name)
reconfigure_jobs_job_config = get_reconfigure_jobs_job_config(
args, config, build_file)
trigger_jobs_job_config = get_trigger_jobs_job_config(
args, config, build_file)
trigger_missed_jobs_job_config = get_trigger_missed_jobs_job_config(
args, config, build_file)
import_upstream_job_config = get_import_upstream_job_config(
args, config, build_file, package_format)
trigger_broken_with_non_broken_upstream_job_config = \
_get_trigger_broken_with_non_broken_upstream_job_config(
args.rosdistro_name, args.release_build_name, build_file)
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins, dry_run=args.dry_run)
job_name = '%s_%s' % (group_name, 'reconfigure-jobs')
configure_job(
jenkins, job_name, reconfigure_jobs_job_config, dry_run=args.dry_run)
job_name = '%s_%s' % (group_name, 'trigger-jobs')
configure_job(
jenkins, job_name, trigger_jobs_job_config, dry_run=args.dry_run)
job_name = '%s_%s' % (group_name, 'trigger-missed-jobs')
configure_job(
jenkins, job_name, trigger_missed_jobs_job_config,
dry_run=args.dry_run)
job_name = 'import_upstream%s' % ('' if package_format == 'deb' else '_' + package_format)
configure_job(
jenkins, job_name, import_upstream_job_config, dry_run=args.dry_run)
job_name = '%s_%s' % \
(group_name, 'trigger-broken-with-non-broken-upstream')
configure_job(
jenkins, job_name, trigger_broken_with_non_broken_upstream_job_config,
dry_run=args.dry_run)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'devel' jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
args = parser.parse_args(argv)
return configure_devel_jobs(
args.config_url, args.rosdistro_name, args.source_build_name)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_dry_run(parser)
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_release_build_files(config, args.rosdistro_name)
build_file = build_files[args.release_build_name]
group_name = get_release_job_prefix(
args.rosdistro_name, args.release_build_name)
reconfigure_jobs_job_config = get_reconfigure_jobs_job_config(
args, config, build_file)
trigger_jobs_job_config = get_trigger_jobs_job_config(
args, config, build_file)
trigger_missed_jobs_job_config = get_trigger_missed_jobs_job_config(
args, config, build_file)
import_upstream_job_config = get_import_upstream_job_config(
args, config, build_file)
trigger_broken_with_non_broken_upstream_job_config = \
_get_trigger_broken_with_non_broken_upstream_job_config(
args.rosdistro_name, args.release_build_name, build_file)
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins, dry_run=args.dry_run)
job_name = '%s_%s' % (group_name, 'reconfigure-jobs')
configure_job(
jenkins, job_name, reconfigure_jobs_job_config, dry_run=args.dry_run)
job_name = '%s_%s' % (group_name, 'trigger-jobs')
configure_job(
jenkins, job_name, trigger_jobs_job_config, dry_run=args.dry_run)
job_name = '%s_%s' % (group_name, 'trigger-missed-jobs')
configure_job(
jenkins, job_name, trigger_missed_jobs_job_config,
dry_run=args.dry_run)
job_name = 'import_upstream'
configure_job(
jenkins, job_name, import_upstream_job_config, dry_run=args.dry_run)
job_name = '%s_%s' % \
(group_name, 'trigger-broken-with-non-broken-upstream')
configure_job(
jenkins, job_name, trigger_broken_with_non_broken_upstream_job_config,
dry_run=args.dry_run)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'doc' jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_groovy_script(parser)
args = parser.parse_args(argv)
return configure_doc_jobs(
args.config_url, args.rosdistro_name, args.doc_build_name,
groovy_script=args.groovy_script)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release' jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_append_timestamp(parser)
args = parser.parse_args(argv)
return configure_release_jobs(
args.config_url, args.rosdistro_name, args.release_build_name,
append_timestamp=args.append_timestamp)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'devel' script")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
# collect all template snippets of specific types
class IncludeHook(Hook):
def __init__(self):
Hook.__init__(self)
self.scms = []
self.scripts = []
def beforeInclude(self, *args, **kwargs):
template_path = kwargs['file'].name
if template_path.endswith('/snippet/scm.xml.em'):
self.scms.append(
(kwargs['locals']['repo_spec'], kwargs['locals']['path']))
if template_path.endswith('/snippet/builder_shell.xml.em'):
self.scripts.append(kwargs['locals']['script'])
hook = IncludeHook()
from ros_buildfarm import templates
templates.template_hooks = [hook]
configure_devel_job(
args.config_url, args.rosdistro_name, args.source_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch,
jenkins=False, views=False)
templates.template_hooks = None
devel_job_name = get_devel_job_name(
args.rosdistro_name, args.source_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch)
value = expand_template(
'devel/devel_script.sh.em', {
'devel_job_name': devel_job_name,
'scms': hook.scms,
'scripts': hook.scripts},
options={BANGPATH_OPT: False})
value = value.replace('python3', sys.executable)
print(value)
def main(argv=sys.argv[1:]):
global templates
parser = argparse.ArgumentParser(
description="Generate a 'devel' script")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
# collect all template snippets of specific types
class IncludeHook(Hook):
def __init__(self):
super(IncludeHook, self).__init__()
self.scms = []
self.scripts = []
def beforeInclude(self, *args, **kwargs):
template_path = kwargs['file'].name
if template_path.endswith('/snippet/scm.xml.em'):
self.scms.append(
(kwargs['locals']['repo_spec'], kwargs['locals']['path']))
if template_path.endswith('/snippet/builder_shell.xml.em'):
self.scripts.append(kwargs['locals']['script'])
hook = IncludeHook()
templates.template_hooks = [hook]
configure_devel_job(
args.config_url, args.rosdistro_name, args.source_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch,
jenkins=False, views=False)
templates.template_hooks = None
devel_job_name = get_devel_job_name(
args.rosdistro_name, args.source_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch)
value = expand_template(
'devel/devel_script.sh.em', {
'devel_job_name': devel_job_name,
'scms': hook.scms,
'scripts': hook.scripts},
options={BANGPATH_OPT: False})
print(value)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Trigger a set of jobs which artifacts are missing in ' +
'the repository')
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_missing_only(parser)
add_argument_source_only(parser)
add_argument_cache_dir(parser, '/tmp/debian_repo_cache')
args = parser.parse_args(argv)
return trigger_release_jobs(
args.config_url, args.rosdistro_name, args.release_build_name,
args.missing_only, args.source_only, args.cache_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'devel' job on Jenkins")
add_argument_rosdistro_index_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
return configure_devel_job(
args.rosdistro_index_url, args.rosdistro_name, args.source_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'release' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_package_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
return configure_release_job(
args.config_url, args.rosdistro_name, args.release_build_name,
args.package_name, args.os_name, args.os_code_name)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'doc' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
configure_doc_job(
args.config_url, args.rosdistro_name, args.doc_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release' jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_groovy_script(parser)
add_argument_dry_run(parser)
add_argument_package_names(parser)
args = parser.parse_args(argv)
return configure_release_jobs(
args.config_url, args.rosdistro_name, args.release_build_name,
groovy_script=args.groovy_script, dry_run=args.dry_run,
whitelist_package_names=args.package_names)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'release_status_page' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_debian_repository_urls(parser, nargs=3)
add_argument_cache_dir(parser, '/tmp/debian_repo_cache')
add_argument_output_dir(parser)
args = parser.parse_args(argv)
return build_release_status_page(
args.config_url, args.rosdistro_name, args.release_build_name,
args.debian_repository_urls[0], args.debian_repository_urls[1],
args.debian_repository_urls[2], args.cache_dir, args.output_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'release' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_package_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
return configure_release_job(args.config_url, args.rosdistro_name,
args.release_build_name, args.package_name,
args.os_name, args.os_code_name)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'devel' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
configure_devel_job(args.config_url, args.rosdistro_name,
args.source_build_name, args.repository_name,
args.os_name, args.os_code_name, args.arch)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Check if the sync criteria are matched to sync ' +
'packages from the building to the testing repo')
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_cache_dir(parser, '/tmp/debian_repo_cache')
args = parser.parse_args(argv)
success = check_sync_criteria(args.config_url, args.rosdistro_name,
args.release_build_name, args.os_code_name,
args.arch, args.cache_dir)
return 0 if success else 1
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'CI' jobs on Jenkins")
# Positional
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'ci')
add_argument_dry_run(parser)
add_argument_groovy_script(parser)
args = parser.parse_args(argv)
return configure_ci_jobs(
args.config_url, args.rosdistro_name, args.ci_build_name,
groovy_script=args.groovy_script, dry_run=args.dry_run)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'CI' job on Jenkins")
# Positional
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'ci')
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
configure_ci_job(
args.config_url, args.rosdistro_name, args.ci_build_name,
args.os_name, args.os_code_name, args.arch)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Check if the sync criteria are matched to sync ' +
'packages from the building to the testing repo')
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_cache_dir(parser, '/tmp/debian_repo_cache')
args = parser.parse_args(argv)
success = check_sync_criteria(
args.config_url, args.rosdistro_name, args.release_build_name,
args.os_code_name, args.arch, args.cache_dir)
return 0 if success else 1
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Generate the release status page')
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_cache_dir(parser, '/tmp/debian_repo_cache')
add_argument_output_dir(parser)
parser.add_argument(
'--copy-resources',
action='store_true',
help='Copy the resources instead of using symlinks')
args = parser.parse_args(argv)
return build_release_status_page(
args.config_url, args.rosdistro_name, args.release_build_name,
args.cache_dir, args.output_dir, copy_resources=args.copy_resources)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'CI' jobs on Jenkins")
# Positional
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'ci', nargs='*')
add_argument_dry_run(parser)
add_argument_groovy_script(parser)
args = parser.parse_args(argv)
return configure_ci_jobs(
args.config_url, args.rosdistro_name,
ci_build_names=args.ci_build_name,
groovy_script=args.groovy_script, dry_run=args.dry_run)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release' jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_groovy_script(parser)
add_argument_dry_run(parser)
add_argument_package_names(parser)
args = parser.parse_args(argv)
print("do configure_release_jobs", file=sys.stderr)
return configure_release_jobs(args.config_url,
args.rosdistro_name,
args.release_build_name,
groovy_script=args.groovy_script,
dry_run=args.dry_run,
whitelist_package_names=args.package_names)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'devel' jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_groovy_script(parser)
add_argument_dry_run(parser)
add_argument_repository_names(parser)
args = parser.parse_args(argv)
return configure_devel_jobs(
args.config_url,
args.rosdistro_name,
args.source_build_name,
groovy_script=args.groovy_script,
dry_run=args.dry_run,
whitelist_repository_names=args.repository_names)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release_status_page' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
args = parser.parse_args(argv)
config = get_index(args.config_url)
job_config = get_job_config(args, config)
jenkins = connect(config.jenkins_url)
view = configure_view(jenkins, JENKINS_MANAGEMENT_VIEW)
job_name = '%s_%s_release-status-page' % \
(args.rosdistro_name, args.release_build_name)
configure_job(jenkins, job_name, job_config, view=view)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'devel' job")
add_argument_rosdistro_index_url(parser, required=True)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_custom_rosdep_urls(parser)
parser.add_argument(
'--prerelease-overlay',
action='store_true',
help='Operate on two catkin workspaces')
add_argument_build_tool(parser, required=True)
add_argument_custom_rosdep_update_options(parser)
add_argument_ros_version(parser)
add_argument_env_vars(parser)
add_argument_dockerfile_dir(parser)
add_argument_run_abichecker(parser)
add_argument_require_gpu_support(parser)
a1 = add_argument_build_tool_args(parser)
a2 = add_argument_build_tool_test_args(parser)
remainder_args = extract_multiple_remainders(argv, (a1, a2))
args = parser.parse_args(argv)
for k, v in remainder_args.items():
setattr(args, k, v)
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls': args.distribution_repository_urls,
'distribution_repository_keys': get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'custom_rosdep_urls': args.custom_rosdep_urls,
'rosdep_update_options': args.custom_rosdep_update_options,
'uid': get_user_id(),
})
create_dockerfile(
'devel/devel_create_tasks.Dockerfile.em', data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release_status_page' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
args = parser.parse_args(argv)
config = get_index(args.config_url)
job_config = get_job_config(args, config)
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins)
prefix = get_release_job_prefix(args.rosdistro_name,
args.release_build_name)
job_name = '%s_release-status-page' % prefix
configure_job(jenkins, job_name, job_config)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Trigger a set of jobs which artifacts are missing in ' +
'the repository')
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_missing_only(parser)
add_argument_source_only(parser)
add_argument_not_failed_only(parser)
add_argument_cause(parser)
add_argument_groovy_script(parser)
add_argument_cache_dir(parser, '/tmp/debian_repo_cache')
args = parser.parse_args(argv)
return trigger_release_jobs(
args.config_url, args.rosdistro_name, args.release_build_name,
args.missing_only, args.source_only, args.cache_dir, cause=args.cause,
groovy_script=args.groovy_script, not_failed_only=args.not_failed_only)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Generate the release status page')
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_cache_dir(parser, '/tmp/debian_repo_cache')
add_argument_output_dir(parser)
parser.add_argument('--copy-resources',
action='store_true',
help='Copy the resources instead of using symlinks')
args = parser.parse_args(argv)
return build_release_status_page(args.config_url,
args.rosdistro_name,
args.release_build_name,
args.cache_dir,
args.output_dir,
copy_resources=args.copy_resources)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release_status_page' job on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
args = parser.parse_args(argv)
config = get_index(args.config_url)
job_config = get_job_config(args, config)
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins)
prefix = get_release_job_prefix(
args.rosdistro_name, args.release_build_name)
job_name = '%s_release-status-page' % prefix
configure_job(jenkins, job_name, job_config)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'release' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_release_build_files(config, args.rosdistro_name)
build_file = build_files[args.release_build_name]
group_name = get_release_job_prefix(args.rosdistro_name,
args.release_build_name)
reconfigure_jobs_job_config = get_reconfigure_jobs_job_config(
args, config, build_file)
trigger_jobs_job_config = get_trigger_jobs_job_config(
args, config, build_file)
import_upstream_job_config = get_import_upstream_job_config(
args, config, build_file)
trigger_broken_with_non_broken_upstream_job_config = \
_get_trigger_broken_with_non_broken_upstream_job_config(
args.rosdistro_name, args.release_build_name, build_file)
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins)
job_name = '%s_%s' % (group_name, 'reconfigure-jobs')
configure_job(jenkins, job_name, reconfigure_jobs_job_config)
job_name = '%s_%s' % (group_name, 'trigger-jobs')
configure_job(jenkins, job_name, trigger_jobs_job_config)
job_name = 'import_upstream'
configure_job(jenkins, job_name, import_upstream_job_config)
job_name = '%s_%s' % \
(group_name, 'trigger-broken-with-non-broken-upstream')
configure_job(jenkins, job_name,
trigger_broken_with_non_broken_upstream_job_config)
def main(argv=sys.argv[1:]):
global templates
parser = argparse.ArgumentParser(
description="Generate a 'devel' script")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
args = parser.parse_args(argv)
# collect all template snippets of specific types
scms = []
scripts = []
def template_hook(template_name, data, content):
if template_name == 'snippet/scm.xml.em':
scms.append((data['repo_spec'], data['path']))
if template_name == 'snippet/builder_shell.xml.em':
scripts.append(data['script'])
templates.template_hook = template_hook
configure_devel_job(
args.config_url, args.rosdistro_name, args.source_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch,
jenkins=False, view=False)
templates.template_hook = None
devel_job_name = get_devel_job_name(
args.rosdistro_name, args.source_build_name,
args.repository_name, args.os_name, args.os_code_name, args.arch)
value = expand_template(
'devel/devel_script.sh.em', {
'devel_job_name': devel_job_name,
'scms': scms,
'scripts': scripts},
options={BANGPATH_OPT: False})
print(value)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'doc_independent' job on Jenkins")
add_argument_config_url(parser)
add_argument_build_name(parser, 'doc')
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_global_doc_build_files(config)
build_file = build_files[args.doc_build_name]
if build_file.documentation_type != DOC_TYPE_MAKE:
print(("The doc build file '%s' has the wrong documentation type to " +
"be used with this script") % args.doc_build_name,
file=sys.stderr)
return 1
return configure_doc_independent_job(
args.config_url, args.doc_build_name,
config=config, build_file=build_file)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate the 'devel' management jobs on Jenkins")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
args = parser.parse_args(argv)
config = get_index(args.config_url)
build_files = get_source_build_files(config, args.rosdistro_name)
build_file = build_files[args.source_build_name]
jenkins = connect(config.jenkins_url)
configure_management_view(jenkins)
group_name = get_devel_view_name(
args.rosdistro_name, args.source_build_name)
configure_reconfigure_jobs_job(
jenkins, group_name, args, config, build_file)
configure_trigger_jobs_job(jenkins, group_name, build_file)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(description="Run the 'release_status_page' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, "release")
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
data = copy.deepcopy(args.__dict__)
data.update(
{
"distribution_repository_urls": args.distribution_repository_urls,
"distribution_repository_keys": get_distribution_repository_keys(
args.distribution_repository_urls, args.distribution_repository_key_files
),
"uid": get_user_id(),
}
)
create_dockerfile("status/release_status_page_task.Dockerfile.em", data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Run the 'check_sync_criteria' job")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
parser.add_argument('os_name',
nargs='?',
help='An OS name from the build file')
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_cache_dir(parser)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
if args.os_name is None:
print('WARNING: Calling %s without specifying os_name is deprecated' %
argv[0],
file=sys.stderr)
args.os_name = 'ubuntu'
data = copy.deepcopy(args.__dict__)
data.update({
'distribution_repository_urls':
args.distribution_repository_urls,
'distribution_repository_keys':
get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'uid':
get_user_id(),
})
create_dockerfile('release/release_check_sync_criteria_task.Dockerfile.em',
data, args.dockerfile_dir)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(description="Generate a 'release' script")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'release')
add_argument_package_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
parser.add_argument('--skip-install',
action='store_true',
help='Skip trying to install binarydeb')
args = parser.parse_args(argv)
# collect all template snippets of specific types
class IncludeHook(Hook):
def __init__(self):
Hook.__init__(self)
self.scripts = []
def beforeFile(self, *args, **kwargs):
template_path = kwargs['file'].name
if template_path.endswith('/release/binarydeb_job.xml.em'):
self.scripts.append('--')
if template_path.endswith('/snippet/builder_shell.xml.em'):
self.scripts.append(kwargs['locals']['script'])
hook = IncludeHook()
from ros_buildfarm import templates
templates.template_hooks = [hook]
configure_release_job(args.config_url,
args.rosdistro_name,
args.release_build_name,
args.package_name,
args.os_name,
args.os_code_name,
jenkins=False,
views=[],
generate_import_package_job=False,
generate_sync_packages_jobs=False,
filter_arches=args.arch)
templates.template_hooks = None
source_job_name = get_sourcedeb_job_name(args.rosdistro_name,
args.release_build_name,
args.package_name, args.os_name,
args.os_code_name)
binary_job_name = get_binarydeb_job_name(args.rosdistro_name,
args.release_build_name,
args.package_name, args.os_name,
args.os_code_name, args.arch)
separator_index = hook.scripts.index('--')
source_scripts = hook.scripts[:separator_index]
binary_scripts = hook.scripts[separator_index + 1:]
# inject additional argument to skip fetching sourcedeb from repo
script_name = '/run_binarydeb_job.py '
additional_argument = '--skip-download-sourcedeb '
for i, script in enumerate(binary_scripts):
offset = script.find(script_name)
if offset != -1:
offset += len(script_name)
script = script[:offset] + additional_argument + script[offset:]
binary_scripts[i] = script
break
# remove rm command for sourcedeb location
rm_command = 'rm -fr $WORKSPACE/binarydeb'
for i, script in enumerate(binary_scripts):
offset = script.find(rm_command)
if offset != -1:
script = script[:offset] + script[offset + len(rm_command):]
binary_scripts[i] = script
break
if args.skip_install:
# remove install step
script_name = '/create_binarydeb_install_task_generator.py '
for i, script in enumerate(binary_scripts):
offset = script.find(script_name)
if offset != -1:
del binary_scripts[i]
break
value = expand_template('release/release_script.sh.em', {
'source_job_name': source_job_name,
'binary_job_name': binary_job_name,
'source_scripts': source_scripts,
'binary_scripts': binary_scripts
},
options={BANGPATH_OPT: False})
value = value.replace('python3', sys.executable)
print(value)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate `manifest.yaml` from released package manifests")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_output_dir(parser, required=True)
args = parser.parse_args(argv)
config = get_config_index(args.config_url)
build_files = get_doc_build_files(config, args.rosdistro_name)
build_file = build_files[args.doc_build_name]
source_build_files = get_source_build_files(config, args.rosdistro_name)
release_build_files = get_release_build_files(config, args.rosdistro_name)
index = get_index(config.rosdistro_index_url)
distribution = get_cached_distribution(index, args.rosdistro_name)
# get rosdistro distribution cache
# iterate over all released repositories
# which don't have a doc entry
# extract information from package.xml and generate manifest.yaml
repo_names = get_repo_names_with_release_but_no_doc(distribution)
pkg_names = get_package_names(distribution, repo_names)
filtered_pkg_names = build_file.filter_packages(pkg_names)
print("Generate 'manifest.yaml' files for the following packages:")
api_path = os.path.join(args.output_dir, 'api')
for pkg_name in sorted(filtered_pkg_names):
print('- %s' % pkg_name)
try:
data = get_metadata(distribution, pkg_name)
except Exception:
print('Could not extract meta data:', file=sys.stderr)
traceback.print_exc(file=sys.stderr)
continue
# add devel job urls
rel_pkg = distribution.release_packages[pkg_name]
repo_name = rel_pkg.repository_name
repo = distribution.repositories[repo_name]
if repo.source_repository and repo.source_repository.version:
build_files = {}
for build_name in source_build_files.keys():
build_files[build_name] = source_build_files[build_name]
devel_job_urls = get_devel_job_urls(config.jenkins_url,
build_files,
args.rosdistro_name, repo_name)
if devel_job_urls:
data['devel_jobs'] = devel_job_urls
# add release job urls
build_files = {}
for build_name in release_build_files.keys():
build_files[build_name] = release_build_files[build_name]
release_job_urls = get_release_job_urls(config.jenkins_url,
build_files,
args.rosdistro_name, pkg_name)
if release_job_urls:
data['release_jobs'] = release_job_urls
manifest_yaml = os.path.join(api_path, pkg_name, 'manifest.yaml')
write_manifest_yaml(manifest_yaml, data)
return 0
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(description="Generate a 'devel' script")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'source')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_build_tool(parser)
args = parser.parse_args(argv)
# collect all template snippets of specific types
class IncludeHook(Hook):
def __init__(self):
Hook.__init__(self)
self.scms = []
self.scripts = []
def beforeInclude(self, *_, **kwargs):
template_path = kwargs['file'].name
if template_path.endswith('/snippet/scm.xml.em'):
self.scms.append(
(kwargs['locals']['repo_spec'], kwargs['locals']['path']))
if template_path.endswith('/snippet/builder_shell.xml.em'):
script = kwargs['locals']['script']
# reuse existing ros_buildfarm folder if it exists
if 'Clone ros_buildfarm' in script:
lines = script.splitlines()
lines.insert(0, 'if [ ! -d "ros_buildfarm" ]; then')
lines += [
'else',
'echo "Using existing ros_buildfarm folder"',
'fi',
]
script = '\n'.join(lines)
if args.build_tool and ' --build-tool ' in script:
script = script.replace(
' --build-tool catkin_make_isolated',
' --build-tool ' + args.build_tool)
self.scripts.append(script)
hook = IncludeHook()
from ros_buildfarm import templates
templates.template_hooks = [hook]
config = get_config_index(args.config_url)
build_files = get_source_build_files(config, args.rosdistro_name)
build_file = build_files[args.source_build_name]
configure_devel_job(args.config_url,
args.rosdistro_name,
args.source_build_name,
args.repository_name,
args.os_name,
args.os_code_name,
args.arch,
config=config,
build_file=build_file,
jenkins=False,
views=False)
templates.template_hooks = None
devel_job_name = get_devel_job_name(args.rosdistro_name,
args.source_build_name,
args.repository_name, args.os_name,
args.os_code_name, args.arch)
value = expand_template(
'devel/devel_script.sh.em', {
'devel_job_name': devel_job_name,
'scms': hook.scms,
'scripts': hook.scripts,
'build_tool': args.build_tool or build_file.build_tool
},
options={BANGPATH_OPT: False})
value = value.replace('python3', sys.executable)
print(value)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(description="Generate a 'CI' script")
# Positional
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'ci')
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_build_tool(parser)
a1 = add_argument_package_selection_args(parser)
a2 = add_argument_build_tool_args(parser)
a3 = add_argument_build_tool_test_args(parser)
add_argument_repos_file_urls(parser)
add_argument_skip_cleanup(parser)
add_argument_test_branch(parser)
parser.add_argument(
'--underlay-source-path',
nargs='*',
metavar='DIR_NAME',
help='Path to one or more install spaces to use as an underlay')
remainder_args = extract_multiple_remainders(argv, (a1, a2, a3))
args = parser.parse_args(argv)
for k, v in remainder_args.items():
setattr(args, k, v)
# collect all template snippets of specific types
class IncludeHook(Hook):
def __init__(self):
Hook.__init__(self)
self.scms = []
self.scripts = []
self.parameters = {}
if args.skip_cleanup:
self.parameters['skip_cleanup'] = 'true'
if args.repos_file_urls is not None:
self.parameters['repos_file_urls'] = ' '.join(
args.repos_file_urls)
if args.test_branch is not None:
self.parameters['test_branch'] = args.test_branch
if args.package_selection_args is not None:
self.parameters['package_selection_args'] = ' '.join(
args.package_selection_args)
if args.build_tool_args is not None:
self.parameters['build_tool_args'] = ' '.join(
args.build_tool_args)
if args.build_tool_test_args is not None:
self.parameters['build_tool_test_args'] = ' '.join(
args.build_tool_test_args)
def beforeInclude(self, *_, **kwargs):
template_path = kwargs['file'].name
if template_path.endswith('/snippet/scm.xml.em'):
self.scms.append(
(kwargs['locals']['repo_spec'], kwargs['locals']['path']))
if template_path.endswith('/snippet/builder_shell.xml.em'):
script = kwargs['locals']['script']
# reuse existing ros_buildfarm folder if it exists
if 'Clone ros_buildfarm' in script:
lines = script.splitlines()
lines.insert(0, 'if [ ! -d "ros_buildfarm" ]; then')
lines += [
'else',
'echo "Using existing ros_buildfarm folder"',
'fi',
]
script = '\n'.join(lines)
if args.build_tool and ' --build-tool ' in script:
script = script.replace(
' --build-tool catkin_make_isolated',
' --build-tool ' + args.build_tool)
self.scripts.append(script)
if template_path.endswith(
'/snippet/property_parameters-definition.xml.em'):
for parameter in reversed(kwargs['locals']['parameters']):
name = parameter['name']
value_type = parameter['type']
if value_type in ['string', 'text']:
default_value = parameter['default_value']
elif value_type == 'boolean':
default_value = 'true' if parameter.get(
'default_value', False) else 'false'
else:
continue
self.parameters.setdefault(name, default_value)
hook = IncludeHook()
from ros_buildfarm import templates
templates.template_hooks = [hook]
config = get_config_index(args.config_url)
build_files = get_ci_build_files(config, args.rosdistro_name)
build_file = build_files[args.ci_build_name]
underlay_source_paths = [
os.path.abspath(p) for p in args.underlay_source_path or []
]
configure_ci_job(args.config_url,
args.rosdistro_name,
args.ci_build_name,
args.os_name,
args.os_code_name,
args.arch,
config=config,
build_file=build_file,
jenkins=False,
views=False,
underlay_source_paths=underlay_source_paths)
templates.template_hooks = None
ci_job_name = get_ci_job_name(args.rosdistro_name, args.os_name,
args.os_code_name, args.arch, 'script')
value = expand_template('ci/ci_script.sh.em', {
'ci_job_name': ci_job_name,
'scms': hook.scms,
'scripts': hook.scripts,
'build_tool': args.build_tool or build_file.build_tool,
'parameters': hook.parameters
},
options={BANGPATH_OPT: False})
value = value.replace('python3 ', sys.executable + ' ')
print(value)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(description="Generate a 'doc' script")
add_argument_config_url(parser)
add_argument_rosdistro_name(parser)
add_argument_build_name(parser, 'doc')
add_argument_repository_name(parser)
add_argument_os_name(parser)
add_argument_os_code_name(parser)
add_argument_arch(parser)
add_argument_force(parser)
args = parser.parse_args(argv)
# collect all template snippets of specific types
class IncludeHook(Hook):
def __init__(self):
Hook.__init__(self)
self.scms = []
self.scripts = []
def beforeInclude(self, *args, **kwargs):
template_path = kwargs['file'].name
if template_path.endswith('/snippet/scm.xml.em'):
self.scms.append(
(kwargs['locals']['repo_spec'], kwargs['locals']['path']))
if template_path.endswith('/snippet/builder_shell.xml.em'):
self.scripts.append(kwargs['locals']['script'])
hook = IncludeHook()
from ros_buildfarm import templates
templates.template_hooks = [hook]
configure_doc_job(args.config_url,
args.rosdistro_name,
args.doc_build_name,
args.repository_name,
args.os_name,
args.os_code_name,
args.arch,
jenkins=False,
views=[])
templates.template_hooks = None
scripts = hook.scripts
doc_job_name = get_doc_job_name(args.rosdistro_name, args.doc_build_name,
args.repository_name, args.os_name,
args.os_code_name, args.arch)
# set force flag
force_flag = '$force'
for i, script in enumerate(scripts):
offset = script.find(force_flag)
if offset != -1:
script = script[:offset] + ('true' if args.force else 'false') + \
script[offset + len(force_flag):]
scripts[i] = script
break
# remove rsync from server
rsync_cmd = 'rsync'
for i, script in enumerate(scripts):
offset = script.find(rsync_cmd)
if offset != -1:
del scripts[i]
break
# remove rsync back to server
cmd_part = '--delete'
for i, script in enumerate(scripts):
offset = script.find(cmd_part)
if offset != -1:
del scripts[i]
break
value = expand_template('doc/doc_script.sh.em', {
'doc_job_name': doc_job_name,
'scms': hook.scms,
'scripts': scripts
},
options={BANGPATH_OPT: False})
value = value.replace('python3', sys.executable)
print(value)
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description="Generate a 'Dockerfile' for the doc job")
add_argument_config_url(parser)
parser.add_argument(
'--rosdistro-name',
required=True,
help='The name of the ROS distro to identify the setup file to be '
'sourced')
add_argument_build_name(parser, 'doc')
parser.add_argument('--workspace-root',
required=True,
help='The root path of the workspace to compile')
parser.add_argument('--rosdoc-lite-dir',
required=True,
help='The root path of the rosdoc_lite repository')
parser.add_argument('--catkin-sphinx-dir',
required=True,
help='The root path of the catkin-sphinx repository')
parser.add_argument('--rosdoc-index-dir',
required=True,
help='The root path of the rosdoc_index folder')
add_argument_repository_name(parser)
parser.add_argument('--os-name',
required=True,
help="The OS name (e.g. 'ubuntu')")
parser.add_argument('--os-code-name',
required=True,
help="The OS code name (e.g. 'xenial')")
parser.add_argument('--arch',
required=True,
help="The architecture (e.g. 'amd64')")
add_argument_build_tool(parser, required=True)
add_argument_vcs_information(parser)
add_argument_distribution_repository_urls(parser)
add_argument_distribution_repository_key_files(parser)
add_argument_force(parser)
add_argument_output_dir(parser, required=True)
add_argument_dockerfile_dir(parser)
args = parser.parse_args(argv)
config = get_config_index(args.config_url)
index = get_index(config.rosdistro_index_url)
condition_context = get_package_condition_context(index,
args.rosdistro_name)
with Scope('SUBSECTION', 'packages'):
# find packages in workspace
source_space = os.path.join(args.workspace_root, 'src')
print("Crawling for packages in workspace '%s'" % source_space)
pkgs = find_packages(source_space)
for pkg in pkgs.values():
pkg.evaluate_conditions(condition_context)
pkg_names = [pkg.name for pkg in pkgs.values()]
print('Found the following packages:')
for pkg_name in sorted(pkg_names):
print(' -', pkg_name)
maintainer_emails = set([])
for pkg in pkgs.values():
for m in pkg.maintainers:
maintainer_emails.add(m.email)
if maintainer_emails:
print('Package maintainer emails: %s' %
' '.join(sorted(maintainer_emails)))
rosdoc_index = RosdocIndex(
[os.path.join(args.rosdoc_index_dir, args.rosdistro_name)])
vcs_type, vcs_version, vcs_url = args.vcs_info.split(' ', 2)
with Scope('SUBSECTION', 'determine need to run documentation generation'):
# compare hashes to determine if documentation needs to be regenerated
current_hashes = {}
current_hashes['ros_buildfarm'] = 2 # increase to retrigger doc jobs
current_hashes['rosdoc_lite'] = get_git_hash(args.rosdoc_lite_dir)
current_hashes['catkin-sphinx'] = get_git_hash(args.catkin_sphinx_dir)
repo_dir = os.path.join(args.workspace_root, 'src',
args.repository_name)
current_hashes[args.repository_name] = get_hash(repo_dir)
print('Current repository hashes: %s' % current_hashes)
tag_index_hashes = rosdoc_index.hashes.get(args.repository_name, {})
print('Stored repository hashes: %s' % tag_index_hashes)
skip_doc_generation = current_hashes == tag_index_hashes
if skip_doc_generation:
print('No changes to the source repository or any tooling repository')
if not args.force:
print('Skipping generation of documentation')
# create stamp files
print('Creating marker files to identify that documentation is ' +
'up-to-date')
create_stamp_files(pkg_names, os.path.join(args.output_dir, 'api'))
# check if any entry needs to be updated
print('Creating update manifest.yaml files')
for pkg_name in pkg_names:
# update manifest.yaml files
current_manifest_yaml_file = os.path.join(
args.rosdoc_index_dir, args.rosdistro_name, 'api',
pkg_name, 'manifest.yaml')
if not os.path.exists(current_manifest_yaml_file):
print('- %s: skipping no manifest.yaml yet' % pkg_name)
continue
with open(current_manifest_yaml_file, 'r') as h:
remote_data = yaml.safe_load(h)
data = copy.deepcopy(remote_data)
data['vcs'] = vcs_type
data['vcs_uri'] = vcs_url
data['vcs_version'] = vcs_version
data['depends_on'] = sorted(
rosdoc_index.reverse_deps.get(pkg_name, []))
if data == remote_data:
print('- %s: skipping same data' % pkg_name)
continue
# write manifest.yaml if it has changes
print('- %s: api/%s/manifest.yaml' % (pkg_name, pkg_name))
dst = os.path.join(args.output_dir, 'api', pkg_name,
'manifest.yaml')
dst_dir = os.path.dirname(dst)
if not os.path.exists(dst_dir):
os.makedirs(dst_dir)
with open(dst, 'w') as h:
yaml.dump(data, h, default_flow_style=False)
return 0
print("But job was started with the 'force' parameter set")
else:
print('The source repository and/or a tooling repository has changed')
print('Running generation of documentation')
rosdoc_index.hashes[args.repository_name] = current_hashes
rosdoc_index.write_modified_data(args.output_dir, ['hashes'])
# create stamp files
print('Creating marker files to identify that documentation is ' +
'up-to-date')
create_stamp_files(pkg_names, os.path.join(args.output_dir, 'api_rosdoc'))
dist_file = get_distribution_file(index, args.rosdistro_name)
assert args.repository_name in dist_file.repositories
valid_package_names = \
set(pkg_names) | set(dist_file.release_packages.keys())
# update package deps and metapackage deps
with Scope('SUBSECTION', 'updated rosdoc_index information'):
for pkg in pkgs.values():
print("Updating dependendencies for package '%s'" % pkg.name)
depends = _get_build_run_doc_dependencies(pkg)
ros_dependency_names = sorted(
set([d.name for d in depends
if d.name in valid_package_names]))
rosdoc_index.set_forward_deps(pkg.name, ros_dependency_names)
if pkg.is_metapackage():
print("Updating dependendencies for metapackage '%s'" %
pkg.name)
depends = _get_run_dependencies(pkg)
ros_dependency_names = sorted(
set([
d.name for d in depends
if d.name in valid_package_names
]))
else:
ros_dependency_names = None
rosdoc_index.set_metapackage_deps(pkg.name, ros_dependency_names)
rosdoc_index.write_modified_data(args.output_dir,
['deps', 'metapackage_deps'])
# generate changelog html from rst
package_names_with_changelogs = set([])
with Scope('SUBSECTION', 'generate changelog html from rst'):
for pkg_path, pkg in pkgs.items():
abs_pkg_path = os.path.join(source_space, pkg_path)
assert os.path.exists(os.path.join(abs_pkg_path, 'package.xml'))
changelog_file = os.path.join(abs_pkg_path, 'CHANGELOG.rst')
if os.path.exists(changelog_file):
print(("Package '%s' contains a CHANGELOG.rst, generating " +
"html") % pkg.name)
package_names_with_changelogs.add(pkg.name)
with open(changelog_file, 'r') as h:
rst_code = h.read()
from docutils.core import publish_string
html_code = publish_string(rst_code, writer_name='html')
html_code = html_code.decode()
# strip system message from html output
open_tag = re.escape('<div class="first system-message">')
close_tag = re.escape('</div>')
pattern = '(' + open_tag + '.+?' + close_tag + ')'
html_code = re.sub(pattern, '', html_code, flags=re.DOTALL)
pkg_changelog_doc_path = os.path.join(args.output_dir,
'changelogs', pkg.name)
os.makedirs(pkg_changelog_doc_path)
with open(
os.path.join(pkg_changelog_doc_path, 'changelog.html'),
'w') as h:
h.write(html_code)
ordered_pkg_tuples = topological_order_packages(pkgs)
# create rosdoc tag list and location files
with Scope('SUBSECTION', 'create rosdoc tag list and location files'):
rosdoc_config_files = {}
for pkg_path, pkg in pkgs.items():
abs_pkg_path = os.path.join(source_space, pkg_path)
rosdoc_exports = [
e.attributes['content'] for e in pkg.exports
if e.tagname == 'rosdoc' and 'content' in e.attributes
]
prefix = '${prefix}'
rosdoc_config_file = rosdoc_exports[-1] \
if rosdoc_exports else '%s/rosdoc.yaml' % prefix
rosdoc_config_file = rosdoc_config_file.replace(
prefix, abs_pkg_path)
if os.path.isfile(rosdoc_config_file):
rosdoc_config_files[pkg.name] = rosdoc_config_file
for _, pkg in ordered_pkg_tuples:
dst = os.path.join(args.output_dir, 'rosdoc_tags',
'%s.yaml' % pkg.name)
print("Generating rosdoc tag list file for package '%s'" %
pkg.name)
dep_names = rosdoc_index.get_recursive_dependencies(pkg.name)
# make sure that we don't pass our own tagfile to ourself
# bad things happen when we do this
assert pkg.name not in dep_names
locations = []
for dep_name in sorted(dep_names):
if dep_name not in rosdoc_index.locations:
print("- skipping not existing location file of " +
"dependency '%s'" % dep_name)
continue
print("- including location files of dependency '%s'" %
dep_name)
dep_locations = rosdoc_index.locations[dep_name]
if dep_locations:
for dep_location in dep_locations:
assert dep_location['package'] == dep_name
# update tag information to point to local location
location = copy.deepcopy(dep_location)
if not location['location'].startswith('file://'):
location['location'] = 'file://%s' % os.path.join(
args.rosdoc_index_dir, location['location'])
locations.append(location)
dst_dir = os.path.dirname(dst)
if not os.path.exists(dst_dir):
os.makedirs(dst_dir)
with open(dst, 'w') as h:
yaml.dump(locations, h)
print("Creating location file for package '%s'" % pkg.name)
data = {
'docs_url':
'../../../api/%s/html' % pkg.name,
'location':
'file://%s' %
os.path.join(args.output_dir, 'symbols', '%s.tag' % pkg.name),
'package':
pkg.name,
}
# fetch generator specific output folders from rosdoc_lite
if pkg.name in rosdoc_config_files:
output_folders = get_generator_output_folders(
rosdoc_config_files[pkg.name], pkg.name)
if 'doxygen' in output_folders:
data['docs_url'] += '/' + output_folders['doxygen']
rosdoc_index.locations[pkg.name] = [data]
# do not write these local locations
# used to determine all source and release jobs
source_build_files = get_source_build_files(config, args.rosdistro_name)
release_build_files = get_release_build_files(config, args.rosdistro_name)
# TODO this should reuse the logic from the job generation
used_source_build_names = []
for source_build_name, build_file in source_build_files.items():
repo_names = build_file.filter_repositories([args.repository_name])
if not repo_names:
continue
matching_dist_file = get_distribution_file_matching_build_file(
index, args.rosdistro_name, build_file)
repo = matching_dist_file.repositories[args.repository_name]
if not repo.source_repository:
continue
if not repo.source_repository.version:
continue
if build_file.test_commits_force is False:
continue
elif repo.source_repository.test_commits is False:
continue
elif repo.source_repository.test_commits is None and \
not build_file.test_commits_default:
continue
used_source_build_names.append(source_build_name)
doc_build_files = get_doc_build_files(config, args.rosdistro_name)
doc_build_file = doc_build_files[args.doc_build_name]
# create manifest.yaml files from repository / package meta information
# will be merged with the manifest.yaml file generated by rosdoc_lite later
repository = dist_file.repositories[args.repository_name]
with Scope('SUBSECTION', 'create manifest.yaml files'):
for pkg in pkgs.values():
data = {}
data['vcs'] = vcs_type
data['vcs_uri'] = vcs_url
data['vcs_version'] = vcs_version
data['repo_name'] = args.repository_name
data['timestamp'] = time.time()
data['depends'] = sorted(
rosdoc_index.forward_deps.get(pkg.name, []))
data['depends_on'] = sorted(
rosdoc_index.reverse_deps.get(pkg.name, []))
if pkg.name in rosdoc_index.metapackage_index:
data['metapackages'] = rosdoc_index.metapackage_index[pkg.name]
if pkg.name in rosdoc_index.metapackage_deps:
data['packages'] = rosdoc_index.metapackage_deps[pkg.name]
if pkg.name in package_names_with_changelogs:
data['has_changelog_rst'] = True
data['api_documentation'] = '%s/%s/api/%s/html' % \
(doc_build_file.canonical_base_url, args.rosdistro_name, pkg.name)
pkg_status = None
pkg_status_description = None
# package level status information
if pkg.name in repository.status_per_package:
pkg_status_data = repository.status_per_package[pkg.name]
pkg_status = pkg_status_data.get('status', None)
pkg_status_description = pkg_status_data.get(
'status_description', None)
# repository level status information
if pkg_status is None:
pkg_status = repository.status
if pkg_status_description is None:
pkg_status_description = repository.status_description
if pkg_status is not None:
data['maintainer_status'] = pkg_status
if pkg_status_description is not None:
data['maintainer_status_description'] = pkg_status_description
# add doc job url
data['doc_job'] = get_doc_job_url(config.jenkins_url,
args.rosdistro_name,
args.doc_build_name,
args.repository_name,
args.os_name, args.os_code_name,
args.arch)
# add devel job urls
build_files = {}
for build_name in used_source_build_names:
build_files[build_name] = source_build_files[build_name]
devel_job_urls = get_devel_job_urls(config.jenkins_url,
build_files,
args.rosdistro_name,
args.repository_name)
if devel_job_urls:
data['devel_jobs'] = devel_job_urls
# TODO this should reuse the logic from the job generation
used_release_build_names = []
for release_build_name, build_file in release_build_files.items():
filtered_pkg_names = build_file.filter_packages([pkg.name])
if not filtered_pkg_names:
continue
matching_dist_file = get_distribution_file_matching_build_file(
index, args.rosdistro_name, build_file)
repo = matching_dist_file.repositories[args.repository_name]
if not repo.release_repository:
continue
if not repo.release_repository.version:
continue
used_release_build_names.append(release_build_name)
# add release job urls
build_files = {}
for build_name in used_release_build_names:
build_files[build_name] = release_build_files[build_name]
release_job_urls = get_release_job_urls(config.jenkins_url,
build_files,
args.rosdistro_name,
pkg.name)
if release_job_urls:
data['release_jobs'] = release_job_urls
# write manifest.yaml
dst = os.path.join(args.output_dir, 'manifests', pkg.name,
'manifest.yaml')
dst_dir = os.path.dirname(dst)
if not os.path.exists(dst_dir):
os.makedirs(dst_dir)
with open(dst, 'w') as h:
yaml.dump(data, h)
# overwrite CMakeLists.txt files of each package
with Scope('SUBSECTION',
'overwrite CMakeLists.txt files to only generate messages'):
for pkg_path, pkg in pkgs.items():
abs_pkg_path = os.path.join(source_space, pkg_path)
build_types = [
e.content for e in pkg.exports if e.tagname == 'build_type'
]
build_type_cmake = build_types and build_types[0] == 'cmake'
data = {
'package_name': pkg.name,
'build_type_cmake': build_type_cmake,
}
content = expand_template('doc/CMakeLists.txt.em', data)
print("Generating 'CMakeLists.txt' for package '%s'" % pkg.name)
cmakelist_file = os.path.join(abs_pkg_path, 'CMakeLists.txt')
with open(cmakelist_file, 'w') as h:
h.write(content)
with Scope('SUBSECTION', 'determine dependencies and generate Dockerfile'):
# initialize rosdep view
context = initialize_resolver(args.rosdistro_name, args.os_name,
args.os_code_name)
apt_cache = Cache()
debian_pkg_names = [
'build-essential',
'openssh-client',
'python3',
'python3-yaml',
'rsync',
# the following are required by rosdoc_lite
'doxygen',
# since catkin is not a run dependency but provides the setup files
get_os_package_name(args.rosdistro_name, 'catkin'),
# rosdoc_lite does not work without genmsg being importable
get_os_package_name(args.rosdistro_name, 'genmsg'),
]
if '3' == str(condition_context['ROS_PYTHON_VERSION']):
# the following are required by rosdoc_lite
debian_pkg_names.extend([
'python3-catkin-pkg-modules', 'python3-kitchen',
'python3-rospkg-modules', 'python3-sphinx', 'python3-yaml'
])
else:
if '2' != str(condition_context['ROS_PYTHON_VERSION']):
print('Unknown python version, using Python 2',
condition_context)
# the following are required by rosdoc_lite
debian_pkg_names.extend([
'python-catkin-pkg-modules', 'python-epydoc', 'python-kitchen',
'python-rospkg', 'python-sphinx', 'python-yaml'
])
if args.build_tool == 'colcon':
debian_pkg_names.append('python3-colcon-ros')
if 'actionlib_msgs' in pkg_names:
# to document actions in other packages in the same repository
debian_pkg_names.append(
get_os_package_name(args.rosdistro_name, 'actionlib_msgs'))
print('Always install the following generic dependencies:')
for debian_pkg_name in sorted(debian_pkg_names):
print(' -', debian_pkg_name)
debian_pkg_versions = {}
# get build, run and doc dependencies and map them to binary packages
depends = get_dependencies(pkgs.values(), 'build, run and doc',
_get_build_run_doc_dependencies)
debian_pkg_names_depends = resolve_names(depends, **context)
debian_pkg_names_depends -= set(debian_pkg_names)
debian_pkg_names += order_dependencies(debian_pkg_names_depends)
missing_debian_pkg_names = []
for debian_pkg_name in debian_pkg_names:
try:
debian_pkg_versions.update(
get_binary_package_versions(apt_cache, [debian_pkg_name]))
except KeyError:
missing_debian_pkg_names.append(debian_pkg_name)
if missing_debian_pkg_names:
# we allow missing dependencies to support basic documentation
# of packages which use not released dependencies
print(
'# BEGIN SUBSECTION: MISSING DEPENDENCIES might result in failing build'
)
for debian_pkg_name in missing_debian_pkg_names:
print("Could not find apt package '%s', skipping dependency" %
debian_pkg_name)
debian_pkg_names.remove(debian_pkg_name)
print('# END SUBSECTION')
# generate Dockerfile
data = {
'os_name':
args.os_name,
'os_code_name':
args.os_code_name,
'arch':
args.arch,
'build_tool':
doc_build_file.build_tool,
'distribution_repository_urls':
args.distribution_repository_urls,
'distribution_repository_keys':
get_distribution_repository_keys(
args.distribution_repository_urls,
args.distribution_repository_key_files),
'environment_variables': [
'ROS_PYTHON_VERSION={}'.format(
condition_context['ROS_PYTHON_VERSION'])
],
'rosdistro_name':
args.rosdistro_name,
'uid':
get_user_id(),
'dependencies':
debian_pkg_names,
'dependency_versions':
debian_pkg_versions,
'install_lists': [],
'canonical_base_url':
doc_build_file.canonical_base_url,
'ordered_pkg_tuples':
ordered_pkg_tuples,
'rosdoc_config_files':
rosdoc_config_files,
}
create_dockerfile('doc/doc_task.Dockerfile.em', data,
args.dockerfile_dir)
