Merge pull request #1768 from rosahbruno/1852217-support-python-cli-arg

Author: rosahbruno

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v2.0.1...main)
 
+* [#1768](https://github.com/mozilla/glean.js/pull/1768): Add support for `GLEAN_PYTHON` and `GLEAN_PIP` environment variables.
 * [#1755](https://github.com/mozilla/glean.js/pull/1755): Add sync check to `set` function for the URL metric.
 * [#1766](https://github.com/mozilla/glean.js/pull/1766): Update default `maxEvents` count to 1. This means an events ping will be sent after each recorded event unless the `maxEvents` count is explicitly set to a larger number.
 

bin/python-env-vars-test.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+set -eo pipefail
+
+run() {
+    [ "${VERB:-0}" != 0 ] && echo "+ $*"
+    "$@"
+}
+
+# All sed commands below work with either
+# GNU sed (standard on Linux distrubtions) or BSD sed (standard on macOS)
+SED="sed"
+
+WORKSPACE_ROOT="$( cd "$(dirname "$0")/.." ; pwd -P )"
+
+# Set custom values for Python environment variables.
+if [ -x "$(command -v python)" ]; then
+  export GLEAN_PYTHON=python
+fi
+
+if [ -x "$(command -v pip)" ]; then
+  export GLEAN_PIP=pip
+fi
+
+# Delete the .venv so a new one gets created for testing.
+rm -rf .venv
+
+# Generate files using the Glean.js CLI tool (which just runs glean_parser)
+npm run cli -- \
+  translate tests/integration/schema/metrics.yaml tests/integration/schema/pings.yaml \
+  -f typescript \
+  -o tests/integration/schema/generated
+
+# Update metrics import path
+FILE=glean/tests/integration/schema/generated/forTesting.ts
+run $SED -i.bak -E \
+  -e 's#@mozilla/glean/private/metrics#../../../../src/core/metrics/types#g' \
+  "${WORKSPACE_ROOT}/${FILE}"
+run rm "${WORKSPACE_ROOT}/${FILE}.bak"
+
+# Update ping import path
+FILE=glean/tests/integration/schema/generated/pings.ts
+run $SED -i.bak -E \
+ -e 's#@mozilla/glean/private/ping#../../../../src/core/pings/ping_type.js#g' \
+ "${WORKSPACE_ROOT}/${FILE}"
+run rm "${WORKSPACE_ROOT}/${FILE}.bak"
+
+unset GLEAN_PYTHON
+unset GLEAN_PIP
+
+# Delete the custom .venv so next run uses the default Python binaries.
+rm -rf .venv

glean/package.json

@@ -58,7 +58,7 @@
   "scripts": {
     "test": "run-s test:unit test:integration",
     "test:integration": "npm run test:base -- \"tests/integration/**/*.spec.ts\" --recursive",
-    "pretest:integration": "../bin/parser-for-schema-testing.sh",
+    "pretest:integration": "../bin/parser-for-schema-testing.sh && ../bin/python-env-vars-test.sh",
     "test:unit": "run-s test:unit:core test:unit:platform test:unit:plugins",
     "test:unit:core": "npm run test:base -- \"tests/unit/core/**/*.spec.ts\" --recursive",
     "test:unit:plugins": "npm run test:base -- \"tests/unit/plugins/**/*.spec.ts\" --recursive",

glean/src/cli.ts

@@ -109,6 +109,15 @@ function getSystemPythonBinName(): string {
   return (platform === "win32") ? "python.exe" : "python3";
 }
 
+/**
+ * Gets the name of the Python pip binary, based on the host OS.
+ *
+ * @returns the name of the Python pip binary.
+ */
+function getPipBinName(): string {
+  return (platform === "win32") ? "pip3.exe" : "pip3";
+}
+
 /**
  * Gets the full path to the directory containing the python
  * binaries in the virtual environment.
@@ -137,8 +146,8 @@ function getPythonVenvBinariesPath(venvRoot: string): string {
 async function checkPythonVenvExists(venvPath: string): Promise<boolean> {
   log(LOG_TAG, `Checking for a virtual environment at ${venvPath}`);
 
-  const venvPython =
-    path.join(getPythonVenvBinariesPath(venvPath), getSystemPythonBinName());
+  const pythonBinary = process.env.GLEAN_PYTHON ?? getSystemPythonBinName();
+  const venvPython = path.join(getPythonVenvBinariesPath(venvPath), pythonBinary);
 
   const access = promisify(fs.access);
 
@@ -161,12 +170,14 @@ async function checkPythonVenvExists(venvPath: string): Promise<boolean> {
 async function createPythonVenv(venvPath: string): Promise<boolean> {
   log(LOG_TAG, `Creating a virtual environment at ${venvPath}`);
 
-  const pipFilename = (platform === "win32") ? "pip3.exe" : "pip3";
+  const pipFilename = process.env.GLEAN_PIP ?? getPipBinName();
   const venvPip =
     path.join(getPythonVenvBinariesPath(VIRTUAL_ENVIRONMENT_DIR), pipFilename);
 
   const pipCmd = `${venvPip} install wheel`;
-  const venvCmd = `${getSystemPythonBinName()} -m venv ${VIRTUAL_ENVIRONMENT_DIR}`;
+
+  const pythonBinary = process.env.GLEAN_PYTHON ?? getSystemPythonBinName();
+  const venvCmd = `${pythonBinary} -m venv ${VIRTUAL_ENVIRONMENT_DIR}`;
 
   for (const cmd of [venvCmd, pipCmd]) {
     const spinner = getStartedSpinner();
@@ -207,7 +218,10 @@ async function setup() {
  */
 async function runGlean(parserArgs: string[]) {
   const spinner = getStartedSpinner();
-  const pythonBin = path.join(getPythonVenvBinariesPath(VIRTUAL_ENVIRONMENT_DIR), getSystemPythonBinName());
+
+  const pythonBinary = process.env.GLEAN_PYTHON ?? getSystemPythonBinName();
+  const pythonBin = path.join(getPythonVenvBinariesPath(VIRTUAL_ENVIRONMENT_DIR), pythonBinary);
+
   const isOnlineArg = process.env.OFFLINE ? "offline" : "online";
 
   // Trying to pass PYTHON_SCRIPT as a string in the command line arguments