build_info.py

Go to the documentation of this file.

#!/usr/bin/env python3
# use encoding=utf8
# SPDX-FileCopyrightText: Copyright (c) NumeriCor GmbH
# SPDX-License-Identifier: LicenseRef-APL-1.1
 
"""
Generate a C header file defining some information about the build.
"""
 
import os
import sys
import subprocess
import urllib.parse
 
def run(cmd, env=None):
    """
    Run a command with subprocess and return the stdout.
 
    Avoiding use of subprocess.check_output to maintain backwards
    compatibility.
    """
    proc = subprocess.Popen(cmd, env=env, stdout=subprocess.PIPE)
    out = proc.communicate()
    if proc.returncode != 0:
        tpl = 'execution of command "{0}" failed'
        raise Exception(tpl.format(' '.join(cmd)))
    return out[0]
 
def locale():
    """
    Determine the locale to use in SVN.
    """
 
    de = None
 
    for line in run(['locale', '-a']).split('\n'):
 
        entry = line.strip()
 
        if entry.startswith('en'):
            return entry
 
        if entry.startswith('de'):
            de = entry
 
    # German a good fallback as 'revision' and 'relative url' are the same
    if de is not None:
        return de
 
    # If all else fails
    return 'C'
 
SVN_NAME_MAPPING = {'Révision': 'Revision'}
 
def svn(directory='.'):
    """
    Get information about the SVN repository.
 
    Uses the --show-item syntax instead of parsing the normal svn info output
    to avoid issues with language locales.
    """
 
    start_wd = os.getcwd()
 
    os.chdir(directory)
    result = run(['svn', 'info'], env={'LC_MESSAGES': locale()})
    os.chdir(start_wd)
 
    info = {}
 
    for line in result.split('\n'):
 
        try:
            name, value = line.split(': ')
        except ValueError:
            continue
 
        # Translate where necessary
        name = SVN_NAME_MAPPING.get(name.strip(), name.strip())
        name = name.lower().replace(' ', '-')
 
        info[name] = value.strip()
 
        if name == 'revision':
            info['commit'] = info[name]
 
    return info
 
def git(directory='.'):
    start_wd = os.getcwd()
    os.chdir(directory)
    info = {}
 
    # get the git revision count
    result = run(['git', 'rev-list', '--all', '--count'])
    info['revision'] = str(int(result));
 
    # get commit hash
    result = run(['git', 'rev-parse', 'HEAD'])
    result = result[0:len(result)-1]
    info['commit'] = result.decode('ascii')
 
    # get the git tag
    result = run(['git', 'describe', '--tags', '--always'])
    result = result[0:len(result)-1]
    info['tag'] = result.decode('ascii')
 
    # get the git remote url
    result = run(['git', 'remote', '-v'])
 
    for line in result.decode('ascii').split('\n'):
        line = ' '.join(line.split())
 
        try:
            alias, path, direction = line.split(' ')
        except ValueError:
            continue
 
        if alias == 'origin':
            # drop user-info (e.g. CI job tokens) from the url
            parts = urllib.parse.urlsplit(path)
            info['url'] = urllib.parse.urlunsplit(parts._replace(netloc=parts.netloc.rpartition('@')[2]))
 
    # the subrepo is just '.'
    info['subrepo'] = '.'
 
    os.chdir(start_wd)
 
    return info
 
 
 
TEMPLATE = """// SPDX-FileCopyrightText: Copyright (c) NumeriCor GmbH
// SPDX-License-Identifier: LicenseRef-APL-1.1
 
#ifndef __BUILD_INFO__
#define __BUILD_INFO__
 
#define GIT_COMMIT_TAG       "{tag}"
#define GIT_COMMIT_HASH      "{commit}"
#define GIT_COMMIT_COUNT     {revision}
#define GIT_PATH             "{url}"
 
#define SUBREPO_REVISIONS "{subrepo}"
 
#define SUBREPO_COMMITS "{subrepocommit}"
 
#endif
"""
 
def generate():
 
    # check whether we are in a git repo
    if subprocess.call(["git", "branch"], stderr=subprocess.STDOUT, stdout=open(os.devnull, 'w')) == 0:
        info = git(os.path.dirname(os.path.abspath(__file__)))
    
        # Get subrepo info
        repo_versions = []
        repo_commits  = []
 
        # we currently have no sub-repos. still, we leave the mechanism in here for later
        # repo_versions.append(('slimfem',       git('../fem/slimfem')['revision']))
        # repo_commits.append(( 'slimfem',       git('../fem/slimfem')['commit']))
 
        info['subrepo'] = ','.join(['{0[0]}={0[1]}'.format(v) for v in repo_versions])
 
        # Assemble commit hashes / revisions
        newline = '," \\\n' + ' ' * 24 + '"'
        info['subrepocommit'] = newline.join(['{0[0]}={0[1]}'.format(v) for v in repo_commits])
 
    else:
        info = {}
        info['tag'] = "built outside a repository"
        info['commit'] = "built outside a repository"
        info['revision'] = 0
        info['url'] = "https://git.opencarp.org/openCARP/openCARP.git"
        info['subrepo'] = ""
        info['subrepocommit'] = ""
 
    return TEMPLATE.format(**info)
 
def print_build_info(filename):
    """
    print build info
    """
    git_info = generate()
    update_file = True
 
    # check if there's a change of the build info if the file already exists
    if os.path.isfile(filename):
        with open(filename, 'r') as myfile:
            info_h = myfile.read()
        if info_h == git_info:
           update_file = False
 
    # write build info file
    if update_file:
        f = open(filename, "w")
        f.write(git_info)
 
if __name__ == '__main__':
    if(len(sys.argv) > 1):
        filename = sys.argv[1]
    else:
        filename = 'build_info.h'    
    print_build_info(filename)