Merge pull request #156 from firebase/feature/ak-integration-tests

Add Windows integration tests to workflow

Author: anonymous-akorn

.github/workflows/integration_tests.yml

@@ -71,6 +71,10 @@ jobs:
  - name: Set env vars(all)
  run: echo "::set-env name=VCPKG_RESPONSE_FILE::external/vcpkg_${{ env.VCPKG_TRIPLET }}_response_file.txt"
 
+ - name: Add msbuild to PATH (windows)
+ if: startsWith(matrix.os, 'windows')
+ uses: microsoft/setup-msbuild@v1.0.1
+ 
  - name: Cache vcpkg C++ dependencies
  if: matrix.target_platform == 'Desktop'
  id: cache_vcpkg
@@ -91,6 +95,7 @@ jobs:
  
  - name: Install SDK Android prerequisites
  if: matrix.target_platform == 'Android'
+ shell: bash
  run: |
  build_scripts/android/install_prereqs.sh
  
@@ -105,6 +110,12 @@ jobs:
  NDK_ROOT: '/tmp/android-ndk-r16b'
  run: |
  python scripts/gha/build_testapps.py --t ${{ github.event.inputs.apis }} --p ${{ matrix.target_platform }} --output_directory ${{ github.workspace }} --use_vcpkg --execute_desktop_testapp --noadd_timestamp
+ 
+ # Workaround for https://github.com/GoogleCloudPlatform/github-actions/issues/100
+ # Must be run after the Python setup action
+ - name: Set CLOUDSDK_PYTHON (Windows)
+ if: startsWith(matrix.os, 'windows') && !cancelled()
+ run: echo "::set-env name=CLOUDSDK_PYTHON::${{env.pythonLocation}}\python.exe"
  - name: Install Cloud SDK for mobile integration tests
  if: matrix.target_platform != 'Desktop' && !cancelled()
  uses: GoogleCloudPlatform/github-actions/setup-gcloud@master 

scripts/gha/build_testapps.py

@@ -189,6 +189,11 @@ def main(argv):
  platforms = FLAGS.platforms
  testapps = FLAGS.testapps
 
+ sdk_dir = _fix_path(FLAGS.sdk_dir)
+ output_dir = _fix_path(FLAGS.output_directory)
+ root_dir = _fix_path(FLAGS.root_dir)
+ provisions_dir = _fix_path(FLAGS.provisions_dir)
+
  update_pod_repo = FLAGS.update_pod_repo
  if FLAGS.add_timestamp:
  timestamp = datetime.datetime.now().strftime("%Y_%m_%d-%H_%M_%S")
@@ -204,7 +209,7 @@ def main(argv):
  config = config_reader.read_config()
  cmake_flags = _get_desktop_compiler_flags(FLAGS.compiler, config.compilers)
  if FLAGS.use_vcpkg:
- vcpkg = Vcpkg.generate(os.path.join(FLAGS.sdk_dir, config.vcpkg_dir))
+ vcpkg = Vcpkg.generate(os.path.join(sdk_dir, config.vcpkg_dir))
  vcpkg.install_and_run()
  cmake_flags.extend(vcpkg.cmake_flags)
 
@@ -215,12 +220,12 @@ def main(argv):
  testapp=testapp,
  platforms=platforms,
  api_config=config.get_api(testapp),
- output_dir=os.path.expanduser(FLAGS.output_directory),
- sdk_dir=os.path.expanduser(FLAGS.sdk_dir),
+ output_dir=output_dir,
+ sdk_dir=sdk_dir,
  timestamp=timestamp,
  builder_dir=pathlib.Path(__file__).parent.absolute(),
- root_dir=os.path.expanduser(FLAGS.root_dir),
- provisions_dir=os.path.expanduser(FLAGS.provisions_dir),
+ root_dir=root_dir,
+ provisions_dir=provisions_dir,
  ios_sdk=FLAGS.ios_sdk,
  dev_team=config.apple_team_id,
  cmake_flags=cmake_flags,
@@ -339,17 +344,21 @@ def _get_desktop_compiler_flags(compiler, compiler_table):
 
 def _build_android(project_dir, sdk_dir):
  """Builds an Android binary (apk)."""
+ if platform.system() == "Windows":
+ gradlew = "gradlew.bat"
+ sdk_dir = sdk_dir.replace("\\", "/") # Gradle misinterprets backslashes.
+ else:
+ gradlew = "./gradlew"
  logging.info("Patching gradle properties with path to SDK")
  gradle_properties = os.path.join(project_dir, "gradle.properties")
  with open(gradle_properties, "a+") as f:
  f.write("systemProp.firebase_cpp_sdk.dir=" + sdk_dir + "\n")
  # This will log the versions of dependencies for debugging purposes.
- _run(
- ["./gradlew", "dependencies", "--configuration", "debugCompileClasspath"])
+ _run([gradlew, "dependencies", "--configuration", "debugCompileClasspath"])
  # Building for Android has a known issue that can be worked around by
  # simply building again. Since building from source takes a while, we don't
  # want to retry the build if a different error occurred.
- build_args = ["./gradlew", "assembleDebug", "--stacktrace"]
+ build_args = [gradlew, "assembleDebug", "--stacktrace"]
  result = _run(args=build_args, capture_output=True, text=True, check=False)
  if result.returncode:
  if "Execution failed for task ':generateJsonModel" in result.stderr:
@@ -485,11 +494,19 @@ def _run(args, timeout=2400, capture_output=False, text=None, check=True):
 
 def _rm_dir_safe(directory_path):
  """Removes directory at given path. No error if dir doesn't exist."""
+ logging.info("Deleting %s...", directory_path)
  try:
  shutil.rmtree(directory_path)
- logging.info("Deleted %s", directory_path)
- except FileNotFoundError:
- logging.warning("Tried to delete %s, but it doesn't exist.", directory_path)
+ except OSError as e:
+ # There are two known cases where this can happen:
+ # The directory doesn't exist (FileNotFoundError)
+ # A file in the directory is open in another process (PermissionError)
+ logging.warning("Failed to remove directory:\n%s", e)
+
+
+def _fix_path(path):
+ """Expands ~, normalizes slashes, and converts relative paths to absolute."""
+ return os.path.abspath(os.path.expanduser(path))
 
 
 @attr.s(frozen=True, eq=False)

scripts/gha/test_lab.py

@@ -42,6 +42,7 @@
 import os
 import random
 import string
+import shutil
 import subprocess
 import threading
 
@@ -86,13 +87,26 @@
  " to find available values. If none, will use FTL's default.")
 
 
+# Full paths to the gCloud SDK tools. On Windows, subprocess.run does not check
+# the PATH, so we need to find and supply the full paths.
+# shutil.which returns None if it doesn't find a tool.
+_GCLOUD = shutil.which("gcloud")
+_GSUTIL = shutil.which("gsutil")
+
+
 def main(argv):
  if len(argv) > 1:
  raise app.UsageError("Too many command-line arguments.")
 
- testapp_dir = FLAGS.testapp_dir
+ _verify_gcloud_sdk_command_line_tools()
+
+ testapp_dir = _fix_path(FLAGS.testapp_dir)
+ key_file_path = _fix_path(FLAGS.key_file)
  code_platform = FLAGS.code_platform
 
+ if not os.path.exists(key_file_path):
+ raise ValueError("Key file path does not exist: %s" % key_file_path)
+
  android_device = Device(model=FLAGS.android_model, version=FLAGS.android_api)
  ios_device = Device(model=FLAGS.ios_model, version=FLAGS.ios_version)
 
@@ -111,7 +125,7 @@ def main(argv):
 
  logging.info("Testapps found: %s", "\n".join(path for _, _, path in testapps))
 
- _authorize_gcs(FLAGS.key_file)
+ _authorize_gcs(key_file_path)
 
  gcs_base_dir = _get_base_results_dir()
  logging.info("Storing results in %s", _relative_path_to_gs_uri(gcs_base_dir))
@@ -148,6 +162,19 @@ def main(argv):
  return 0 if all_success else 1
 
 
+def _verify_gcloud_sdk_command_line_tools():
+ """Verifies the presence of the gCloud SDK's command line tools."""
+ logging.info("Looking for gcloud and gsutil tools...")
+ if not _GCLOUD:
+ logging.error("gcloud not on path")
+ if not _GSUTIL:
+ logging.error("gsutil not on path")
+ if not _GCLOUD or not _GSUTIL:
+ raise RuntimeError("Could not find required gCloud SDK tool(s)")
+ subprocess.run([_GCLOUD, "version"], check=True)
+ subprocess.run([_GSUTIL, "version"], check=True)
+
+
 def _get_base_results_dir():
  """Defines the object used on GCS for all tests in this run."""
  # We generate a unique directory to store the results by appending 4
@@ -162,12 +189,12 @@ def _authorize_gcs(key_file):
  """Activates the service account on GCS and specifies the project."""
  subprocess.run(
  args=[
- "gcloud", "auth", "activate-service-account", "--key-file", key_file
+ _GCLOUD, "auth", "activate-service-account", "--key-file", key_file
  ],
  check=True)
  # Keep using this project for subsequent gcloud commands.
  subprocess.run(
- args=["gcloud", "config", "set", "project", _PROJECT_ID],
+ args=[_GCLOUD, "config", "set", "project", _PROJECT_ID],
  check=True)
 
 
@@ -250,20 +277,25 @@ def _relative_path_to_gs_uri(path):
 
 def _gcs_list_dir(gcs_path):
  """Recursively returns a list of contents for a directory on GCS."""
- args = ["gsutil", "ls", "-r", gcs_path]
+ args = [_GSUTIL, "ls", "-r", gcs_path]
  logging.info("Listing GCS contents: %s", " ".join(args))
  result = subprocess.run(args=args, capture_output=True, text=True, check=True)
  return result.stdout.splitlines()
 
 
 def _gcs_read_file(gcs_path):
  """Extracts the contents of a file on GCS."""
- args = ["gsutil", "cat", gcs_path]
+ args = [_GSUTIL, "cat", gcs_path]
  logging.info("Reading GCS file: %s", " ".join(args))
  result = subprocess.run(args=args, capture_output=True, text=True, check=True)
  return result.stdout
 
 
+def _fix_path(path):
+ """Expands ~, normalizes slashes, and converts relative paths to absolute."""
+ return os.path.abspath(os.path.expanduser(path))
+
+
 @attr.s(frozen=False, eq=False)
 class Test(object):
  """Holds data related to the testing of one testapp."""
@@ -293,9 +325,9 @@ def run(self):
  def _gcloud_command(self):
  """Returns the args to send this testapp to FTL on the command line."""
  if self.platform == _ANDROID:
- cmd = ["gcloud", "firebase", "test", "android", "run"]
+ cmd = [_GCLOUD, "firebase", "test", "android", "run"]
  elif self.platform == _IOS:
- cmd = ["gcloud", "beta", "firebase", "test", "ios", "run"]
+ cmd = [_GCLOUD, "beta", "firebase", "test", "ios", "run"]
  else:
  raise ValueError("Invalid platform, must be 'Android' or 'iOS'")
  return cmd + self.device.get_gcloud_flags() + [