summaryrefslogtreecommitdiff
path: root/util/dependency_updater/tools/datasources/gerrit_client.py
blob: 9280db5408576e57ed26bb5125d08ba8b8359fc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
############################################################################
##
## Copyright (C) 2021 The Qt Company Ltd.
## Contact: https://www.qt.io/licensing/
##
## This file is part of the qtqa module of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:LGPL$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 3 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL3 included in the
## packaging of this file. Please review the following information to
## ensure the GNU Lesser General Public License version 3 requirements
## will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 2.0 or (at your option) the GNU General
## Public license version 3 or any later version approved by the KDE Free
## Qt Foundation. The licenses are as published by the Free Software
## Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-2.0.html and
## https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
############################################################################
import os
import signal
from getpass import getpass

import gerrit.utils.exceptions
from gerrit import GerritClient


def test_gerrit_auth(client: GerritClient) -> bool:
    try:
        client.projects.get("qt/qtbase").HEAD
    except gerrit.utils.exceptions.ClientError as e:
        print(e, e.args)
        return False
    print("Gerrit auth OK...")
    return True


def validate_gerrit_config(config, client):
    def input_with_maybe_timeout(func: [input, getpass], message: str) -> str:
        """Try to get input with timeout on Unix-based, or wait indefinitely on Windows."""

        def interrupted(signum, frame):
            """called when read times out"""
            raise TimeoutError

        if os.name == 'posix':
            signal.signal(signal.SIGALRM, interrupted)
            signal.alarm(15)
        try:
            i = func(message)
        except KeyboardInterrupt:
            if os.name == 'posix':
                signal.alarm(0)
            raise KeyboardInterrupt
        if os.name == 'posix':
            signal.alarm(0)
        return i

    while not test_gerrit_auth(client):
        print("Bad Gerrit user or password.\n"
              f"Authenticated access to {config.GERRIT_HOST} is recommended for operation.")
        print(f"\nConfigured username '{config.GERRIT_USERNAME}'")
        try:
            u = input_with_maybe_timeout(input,
                                         "Press Return to accept or re-enter your username now: ")
        except KeyboardInterrupt:
            print("\n\nGerrit Username input cancelled. Proceeding without gerrit authentication!")
            config.GERRIT_USERNAME = ""
            config.GERRIT_PASSWORD = ""
            return create_gerrit_client(config)
        if u:
            config.GERRIT_USERNAME = u
        try:
            p = input_with_maybe_timeout(getpass, "Please re-enter your password: ")
        except KeyboardInterrupt:
            print("\n\nGerrit Username input cancelled. Proceeding without gerrit authentication!")
            config.GERRIT_USERNAME = ""
            config.GERRIT_PASSWORD = ""
        if not p:
            config.GERRIT_USERNAME = ""
            config.GERRIT_PASSWORD = ""
        return create_gerrit_client(config)
    return client


def create_gerrit_client(config):
    """Create an instance of an Gerrit client.
        Will prompt for credentials if not configured."""
    client = GerritClient(base_url=config.GERRIT_HOST, username=config.GERRIT_USERNAME,
                          password=config.GERRIT_PASSWORD)
    client = validate_gerrit_config(config, client)
    return client