Port python deps setup to windows

.github/workflows/python-deps.yml → .github/workflows/python-deps-linux.yml

@@ -1,4 +1,4 @@
-name: Test Python Package Installation
+name: Test Python Package Installation on Linux
 
 on:
   push:

.github/workflows/python-deps-windows.yml

@@ -0,0 +1,61 @@
+name: Test Python Package Installation on Windows
+
+
+on:
+  push:
+    branches: [main, v1]
+  pull_request:
+
+jobs:
+
+  test-setup-python-scripts:
+    runs-on: windows-latest
+    strategy:
+        fail-fast: false
+        matrix:
+          include:
+            - test_dir: python-setup/tests/pipenv/requests-2
+              python_version: 2
+            - test_dir: python-setup/tests/pipenv/requests-3
+              python_version: 3
+
+            - test_dir: python-setup/tests/poetry/requests-2
+              python_version: 2
+            - test_dir: python-setup/tests/poetry/requests-3
+              python_version: 3
+
+            - test_dir: python-setup/tests/requirements/requests-2
+              python_version: 2
+            - test_dir: python-setup/tests/requirements/requests-3
+              python_version: 3
+
+            - test_dir: python-setup/tests/setup_py/requests-2
+              python_version: 2
+            - test_dir: python-setup/tests/setup_py/requests-3
+              python_version: 3
+
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: python
+
+    - name: Test Auto Package Installation
+      run: |
+        $cmd = $Env:GITHUB_WORKSPACE + "\\python-setup\\install_tools.ps1"
+        powershell -File $cmd
+
+        cd $Env:GITHUB_WORKSPACE\\${{ matrix.test_dir }}
+        py -3 $Env:GITHUB_WORKSPACE\\python-setup\\auto_install_packages.py C:\\hostedtoolcache\\windows\\CodeQL\\0.0.0-20200826\\x64\\codeql
+    - name: Setup for extractor
+      run: |
+        echo $Env:CODEQL_PYTHON
+
+        py -3 $Env:GITHUB_WORKSPACE\\python-setup\\tests\\from_python_exe.py $Env:CODEQL_PYTHON 
+    - name: Verify packages installed
+      run: |
+        $cmd = $Env:GITHUB_WORKSPACE + "\\python-setup\\tests\\check_requests_123.ps1"
+        powershell -File $cmd ${{ matrix.python_version }}

python-setup/auto_install_packages.py

@@ -23,8 +23,13 @@ def _check_output(command):
 
 
 def install_packages_with_poetry():
+    command = [sys.executable, '-m', 'poetry']
+    if sys.platform.startswith('win32'):
+        # In windows the default path were the deps are installed gets wiped out between steps,
+        # so we have to set it up to a folder that will be kept
+        os.environ['POETRY_VIRTUALENVS_PATH'] = os.path.join(os.environ['RUNNER_WORKSPACE'], 'virtualenvs')
     try:
-        _check_call(['poetry', 'install', '--no-root'])
+        _check_call(command + ['install', '--no-root'])
     except subprocess.CalledProcessError:
         sys.exit('package installation with poetry failed, see error above')
 
@@ -33,44 +38,69 @@ def install_packages_with_poetry():
     # virtualenv for the package, which was the case for using poetry for Python 2 when
     # default system interpreter was Python 3 :/
 
-    poetry_out = _check_output(['poetry', 'run', 'which', 'python'])
+    poetry_out = _check_output(command + ['run', 'which', 'python'])
     python_executable_path = poetry_out.decode('utf-8').splitlines()[-1]
 
+    if sys.platform.startswith('win32'):
+        # Poetry produces a path that starts by /d instead of D:\ and Windows doesn't like that way of specifying the drive letter.
+        # We completely remove it because it is not needed as everything is in the same drive (We are installing the dependencies in the RUNNER_WORKSPACE)
+        python_executable_path = python_executable_path[2:]
     return python_executable_path
 
 
 def install_packages_with_pipenv():
+    command = [sys.executable, '-m', 'pipenv']
+    if sys.platform.startswith('win32'):
+        # In windows the default path were the deps are installed gets wiped out between steps,
+        # so we have to set it up to a folder that will be kept
+        os.environ['WORKON_HOME'] = os.path.join(os.environ['RUNNER_WORKSPACE'], 'virtualenvs')
     try:
-        _check_call(['pipenv', 'install', '--keep-outdated', '--ignore-pipfile'])
+        _check_call(command + ['install', '--keep-outdated', '--ignore-pipfile'])
     except subprocess.CalledProcessError:
         sys.exit('package installation with pipenv failed, see error above')
 
-    pipenv_out = _check_output(['pipenv', 'run', 'which', 'python'])
+    pipenv_out = _check_output(command + ['run', 'which', 'python'])
     python_executable_path = pipenv_out.decode('utf-8').splitlines()[-1]
 
+    if sys.platform.startswith('win32'):
+        # Pipenv produces a path that starts by /d instead of D:\ and Windows doesn't like that way of specifying the drive letter.
+        # We completely remove it because it is not needed as everything is in the same drive (We are installing the dependencies in the RUNNER_WORKSPACE)
+        python_executable_path = python_executable_path[2:]
     return python_executable_path
 
 
 def _create_venv(version: int):
     # create temporary directory ... that just lives "forever"
-    venv_path = mkdtemp(prefix='codeql-action-python-autoinstall-')
+    venv_path = os.path.join(os.environ['RUNNER_WORKSPACE'], 'codeql-action-python-autoinstall')
+    print ("Creating venv in " + venv_path, flush = True)
 
     # virtualenv is a bit nicer for setting up virtual environment, since it will provide
     # up-to-date versions of pip/setuptools/wheel which basic `python3 -m venv venv` won't
 
-    if version == 2:
-        _check_call(['python2', '-m', 'virtualenv', venv_path])
-    elif version == 3:
-        _check_call(['python3', '-m', 'virtualenv', venv_path])
+    if sys.platform.startswith('win32'):
+        if version == 2:
+            _check_call(['py', '-2', '-m', 'virtualenv', venv_path])
+        elif version == 3:
+            _check_call(['py', '-3', '-m', 'virtualenv', venv_path])
+    else:
+        if version == 2:
+            _check_call(['python2', '-m', 'virtualenv', venv_path])
+        elif version == 3:
+            _check_call(['python3', '-m', 'virtualenv', venv_path])
 
     return venv_path
 
 
 def install_requirements_txt_packages(version: int):
     venv_path = _create_venv(version)
+
     venv_pip = os.path.join(venv_path, 'bin', 'pip')
     venv_python = os.path.join(venv_path, 'bin', 'python')
 
+    if sys.platform.startswith('win32'):
+        venv_pip = os.path.join(venv_path, 'Scripts', 'pip')
+        venv_python = os.path.join(venv_path, 'Scripts', 'python')
+
     try:
         _check_call([venv_pip, 'install', '-r', 'requirements.txt'])
     except subprocess.CalledProcessError:
@@ -81,9 +111,14 @@ def install_requirements_txt_packages(version: int):
 
 def install_with_setup_py(version: int):
     venv_path = _create_venv(version)
+
     venv_pip = os.path.join(venv_path, 'bin', 'pip')
     venv_python = os.path.join(venv_path, 'bin', 'python')
 
+    if sys.platform.startswith('win32'):
+        venv_pip = os.path.join(venv_path, 'Scripts', 'pip')
+        venv_python = os.path.join(venv_path, 'Scripts', 'python')
+
     try:
         # We have to choose between `python setup.py develop` and `pip install -e .`.
         # Modern projects use `pip install -e .` and I wasn't able to see any downsides
@@ -135,10 +170,6 @@ def install_packages(codeql_base_dir) -> Optional[str]:
 
     codeql_base_dir = sys.argv[1]
 
-    # The binaries for packages installed with `pip install --user` are not available on
-    # PATH by default, so we need to manually add them.
-    os.environ['PATH'] = os.path.expanduser('~/.local/bin') + os.pathsep + os.environ['PATH']
-
     python_executable_path = install_packages(codeql_base_dir)
 
     if python_executable_path is not None:

python-setup/install_tools.ps1

@@ -0,0 +1,13 @@
+#! /usr/bin/pwsh
+
+py -2 -m pip install --user --upgrade pip setuptools wheel
+py -3 -m pip install --user --upgrade pip setuptools wheel
+
+# virtualenv is a bit nicer for setting up virtual environment, since it will provide up-to-date versions of
+# pip/setuptools/wheel which basic `python3 -m venv venv` won't
+py -2 -m pip install --user virtualenv
+py -3 -m pip install --user virtualenv
+
+# poetry 1.0.10 has error (https://github.com/python-poetry/poetry/issues/2711)
+py -3 -m pip install --user poetry!=1.0.10
+py -3 -m pip install --user pipenv

python-setup/tests/check_requests_123.ps1

@@ -0,0 +1,28 @@
+#! /usr/bin/pwsh
+
+$EXPECTED_VERSION=$args[0]
+
+$FOUND_VERSION="$Env:LGTM_PYTHON_SETUP_VERSION"
+$FOUND_PYTHONPATH="$Env:LGTM_INDEX_IMPORT_PATH"
+
+write-host "FOUND_VERSION=$FOUND_VERSION FOUND_PYTHONPATH=$FOUND_PYTHONPATH "
+
+if ($FOUND_VERSION -ne $EXPECTED_VERSION) {
+    write-host "Script told us to use Python $FOUND_VERSION, but expected $EXPECTED_VERSION"
+    exit 1
+} else {
+    write-host "Script told us to use Python $FOUND_VERSION, which was expected"
+}
+
+$env:PYTHONPATH=$FOUND_PYTHONPATH
+
+$INSTALLED_REQUESTS_VERSION = (py -3 -c "import requests; print(requests.__version__)")
+
+$EXPECTED_REQUESTS="1.2.3"
+
+if ($INSTALLED_REQUESTS_VERSION -ne $EXPECTED_REQUESTS) {
+    write-host "Using $FOUND_PYTHONPATH as PYTHONPATH, we found version $INSTALLED_REQUESTS_VERSION of requests, but expected $EXPECTED_REQUESTS"
+    exit 1
+} else {
+    write-host "Using $FOUND_PYTHONPATH as PYTHONPATH, we found version $INSTALLED_REQUESTS_VERSION of requests, which was expected"
+}