1#!/usr/bin/env python3
2"""Install all the required Python packages, with the minimum Python version.
3"""
4
5# Copyright The Mbed TLS Contributors
6# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
7
8import argparse
9import os
10import re
11import subprocess
12import sys
13import tempfile
14import typing
15
16from typing import List, Optional
17from mbedtls_dev import typing_util
18
19def pylint_doesn_t_notice_that_certain_types_are_used_in_annotations(
20        _list: List[typing.Any],
21) -> None:
22    pass
23
24
25class Requirements:
26    """Collect and massage Python requirements."""
27
28    def __init__(self) -> None:
29        self.requirements = [] #type: List[str]
30
31    def adjust_requirement(self, req: str) -> str:
32        """Adjust a requirement to the minimum specified version."""
33        # allow inheritance #pylint: disable=no-self-use
34        # If a requirement specifies a minimum version, impose that version.
35        split_req = req.split(';', 1)
36        split_req[0] = re.sub(r'>=|~=', r'==', split_req[0])
37        return ';'.join(split_req)
38
39    def add_file(self, filename: str) -> None:
40        """Add requirements from the specified file.
41
42        This method supports a subset of pip's requirement file syntax:
43        * One requirement specifier per line, which is passed to
44          `adjust_requirement`.
45        * Comments (``#`` at the beginning of the line or after whitespace).
46        * ``-r FILENAME`` to include another file.
47        """
48        for line in open(filename):
49            line = line.strip()
50            line = re.sub(r'(\A|\s+)#.*', r'', line)
51            if not line:
52                continue
53            m = re.match(r'-r\s+', line)
54            if m:
55                nested_file = os.path.join(os.path.dirname(filename),
56                                           line[m.end(0):])
57                self.add_file(nested_file)
58                continue
59            self.requirements.append(self.adjust_requirement(line))
60
61    def write(self, out: typing_util.Writable) -> None:
62        """List the gathered requirements."""
63        for req in self.requirements:
64            out.write(req + '\n')
65
66    def install(
67            self,
68            pip_general_options: Optional[List[str]] = None,
69            pip_install_options: Optional[List[str]] = None,
70    ) -> None:
71        """Call pip to install the requirements."""
72        if pip_general_options is None:
73            pip_general_options = []
74        if pip_install_options is None:
75            pip_install_options = []
76        with tempfile.TemporaryDirectory() as temp_dir:
77            # This is more complicated than it needs to be for the sake
78            # of Windows. Use a temporary file rather than the command line
79            # to avoid quoting issues. Use a temporary directory rather
80            # than NamedTemporaryFile because with a NamedTemporaryFile on
81            # Windows, the subprocess can't open the file because this process
82            # has an exclusive lock on it.
83            req_file_name = os.path.join(temp_dir, 'requirements.txt')
84            with open(req_file_name, 'w') as req_file:
85                self.write(req_file)
86            subprocess.check_call([sys.executable, '-m', 'pip'] +
87                                  pip_general_options +
88                                  ['install'] + pip_install_options +
89                                  ['-r', req_file_name])
90
91DEFAULT_REQUIREMENTS_FILE = 'ci.requirements.txt'
92
93def main() -> None:
94    """Command line entry point."""
95    parser = argparse.ArgumentParser(description=__doc__)
96    parser.add_argument('--no-act', '-n',
97                        action='store_true',
98                        help="Don't act, just print what will be done")
99    parser.add_argument('--pip-install-option',
100                        action='append', dest='pip_install_options',
101                        help="Pass this option to pip install")
102    parser.add_argument('--pip-option',
103                        action='append', dest='pip_general_options',
104                        help="Pass this general option to pip")
105    parser.add_argument('--user',
106                        action='append_const', dest='pip_install_options',
107                        const='--user',
108                        help="Install to the Python user install directory"
109                             " (short for --pip-install-option --user)")
110    parser.add_argument('files', nargs='*', metavar='FILE',
111                        help="Requirement files"
112                             " (default: {} in the script's directory)" \
113                             .format(DEFAULT_REQUIREMENTS_FILE))
114    options = parser.parse_args()
115    if not options.files:
116        options.files = [os.path.join(os.path.dirname(__file__),
117                                      DEFAULT_REQUIREMENTS_FILE)]
118    reqs = Requirements()
119    for filename in options.files:
120        reqs.add_file(filename)
121    reqs.write(sys.stdout)
122    if not options.no_act:
123        reqs.install(pip_general_options=options.pip_general_options,
124                     pip_install_options=options.pip_install_options)
125
126if __name__ == '__main__':
127    main()
128