OpenRVDAS version/repo origin API call

[webbpinner]

API call for retrieving the current OpenRVDAS version and git repo origin.

Call to be used to dynamically display the OpenRVDAS version on the Django-based UI and provide a path for retrieving the information by 3rd-party.

[davidpablocohn]

First pass of code for this submitted by @ellapiet as #482

[webbpinner]

Here's a pure python version that doesn't require subprocess:

import os
import logging

try:
    from git import Repo, InvalidGitRepositoryError, GitCommandError
    GIT_PYTHON_ENABLED = True
except ModuleNotFoundError:
    GIT_PYTHON_ENABLED = False


def get_git_info(path="."):
    """
    Returns a dict containing:
        tag:         tag or describe output
        remote_url:  URL of origin or first remote
        branch:      current branch (or None if detached)
        commit:      HEAD commit hash
    """
    if not GIT_PYTHON_ENABLED:
        raise ModuleNotFoundError(
            'GitPython is not installed. Try "pip install GitPython".'
        )

    info = {"tag": None, "remote_url": None, "branch": None, "commit": None}

    try:
        repo = Repo(os.path.abspath(path), search_parent_directories=True)

        # Commit hash
        info["commit"] = repo.head.commit.hexsha

        # Branch name (safe)
        try:
            info["branch"] = repo.active_branch.name
        except Exception:
            info["branch"] = None  # detached HEAD

        # Tag detection
        commit = repo.commit("HEAD")
        tags = [tag for tag in repo.tags if tag.commit == commit]

        if tags:
            info["tag"] = tags[0].name
        else:
            try:
                info["tag"] = repo.git.describe('--tags', '--always').strip()
            except GitCommandError:
                info["tag"] = None

        # Remote URL
        try:
            if repo.remotes:
                if "origin" in repo.remotes:
                    info["remote_url"] = repo.remotes.origin.url
                else:
                    info["remote_url"] = list(repo.remotes)[0].url
        except Exception:
            info["remote_url"] = None

        return info

    except InvalidGitRepositoryError:
        logging.error("Not a git repository: %s", path)
        return info
    except Exception as err:
        logging.error("Error determining git info: %s", err)
        return info

testing in the current dev branch... here what it returns:

{'tag': 'a2.0.5-33-ge251b19', 'remote_url': 'https://github.com/oceandatatools/openrvdas', 'branch': 'dev', 'commit': 'e251b194f194c4ca6b596cf0e8790e792d002f70'}