Apply automatic fixes

Author: Peter Mounce

.buildkite/local-pipeline.yml

@@ -1,5 +1,6 @@
+---
 steps:
-  - label: "Test"
+  - label: Test
     command: echo "Hello World"
     env:
       BUILDKITE_CLEAN_CHECKOUT: true
@@ -19,4 +20,4 @@ steps:
   #         p4port: localhost:1666
   #         p4user: banana
   #         stream: //stream-depot/main # will checkout to ../../__stream_depot_main
-  #         share_workspace: yes
+  #         share_workspace: yes

.travis.yml

@@ -1,12 +1,13 @@
+---
 language: python
 # cache: pip # not enough installed via pip to justify
 python:
-  - "3.6"
+  - '3.6'
 os:
   - linux
 before_install:
   - pip install -U pip
-install: 
+install:
   - pip install -r ./ci/requirements.txt
   - pip install -r ./python/requirements.txt
   - ./ci/install_$TRAVIS_OS_NAME.sh

dev/setup_env_osx.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 set -eo pipefail
 
-command -v "python3" >/dev/null 2>&1 ||  { echo >&2 "I require python3 but it's not installed. Officially supported version is 3.7.5"; exit 1; }
+command -v "python3" >/dev/null 2>&1 || {
+  echo >&2 "I require python3 but it's not installed. Officially supported version is 3.7.5"
+  exit 1
+}
 
 readonly root="${BASH_SOURCE%/*}/.."
 
@@ -13,23 +16,23 @@ python3 -m virtualenv "${venv_dir}"
 
 platform=$(python3 -c "import platform; print(platform.system())")
 if [[ "${platform}" == "Windows" ]]; then
-    venv_bin="${venv_dir}/Scripts"
+  venv_bin="${venv_dir}/Scripts"
 else
-    venv_bin="${venv_dir}/bin"
+  venv_bin="${venv_dir}/bin"
 fi
 
 "${venv_bin}/python" -m pip install -r "${root}/python/requirements.txt"
 "${venv_bin}/python" -m pip install -r "${root}/ci/requirements.txt"
 
 # Install p4d binary if missing
 if ! [[ -x "$(command -v p4d)" ]]; then
-    wget http://www.perforce.com/downloads/perforce/r18.2/bin.macosx1010x86_64/p4d && sudo chmod +x p4d && sudo mv p4d /usr/local/bin/p4d
+  wget http://www.perforce.com/downloads/perforce/r18.2/bin.macosx1010x86_64/p4d && sudo chmod +x p4d && sudo mv p4d /usr/local/bin/p4d
 fi
 
 if ! p4d -V | grep '2018.2'; then
-    echo "WARNING: Version r18.2 (2018.2) of p4d is recommended for running tests. This version may not be compatible with existing server fixture."
+  echo "WARNING: Version r18.2 (2018.2) of p4d is recommended for running tests. This version may not be compatible with existing server fixture."
 fi
 
 if ! [[ -x "$(command -v bk)" ]]; then
-    echo "WARNING: `bk` cli is not installed. https://github.com/buildkite/cli"
+  echo "WARNING: $(bk) cli is not installed. https://github.com/buildkite/cli"
 fi

examples/buildkite-trigger.py

@@ -3,34 +3,38 @@
 # my-pipeline change-commit //depot/... "python %//depot/scripts/buildkite-trigger.py% <pipeline> %changelist% %user%"
 import sys
 import subprocess
+
 try:
     from urllib.request import urlopen, Request
 except ImportError:
     from urllib2 import urlopen, Request
 import json
 
 __BUILDKITE_TOKEN__ = "<your_token>"
- 
+
 __ORG_SLUG__ = "<your_org>"
 pipeline_slug = sys.argv[1]
 changelist = sys.argv[2]
 user = sys.argv[3]
 
-description = subprocess.check_output(["p4", "-Ztag", "-F", "%desc%", "describe", changelist])
+description = subprocess.check_output(
+    ["p4", "-Ztag", "-F", "%desc%", "describe", changelist]
+)
 
 headers = {
     'Content-Type': 'application/json',
-    'Authorization': 'Bearer %s' % __BUILDKITE_TOKEN__
+    'Authorization': 'Bearer %s' % __BUILDKITE_TOKEN__,
 }
 payload = {
     'commit': '@' + changelist,
     'branch': 'master',
     'message': description,
-    'author': {
-        'name': user
-    }
+    'author': {'name': user},
 }
-url = "https://api.buildkite.com/v2/organizations/%s/pipelines/%s/builds" % (__ORG_SLUG__, pipeline_slug)
+url = "https://api.buildkite.com/v2/organizations/%s/pipelines/%s/builds" % (
+    __ORG_SLUG__,
+    pipeline_slug,
+)
 
 params = json.dumps(payload).encode('utf8')
 req = Request(url, data=params, headers=headers)

examples/buildkite-trigger.sh

@@ -1,7 +1,6 @@
 #!/bin/bash
 set -euo pipefail
 
-
 # P4 Trigger script that triggers buildkite builds
 # Usage:
 # my-pipeline change-commit //depot/... "%//depot/scripts/buildkite-trigger.sh% <organisation> <pipeline> %changelist% %user% %email%"

examples/cleanup-unused-workspaces.py

@@ -27,16 +27,24 @@
 
 # Filter by basic prefix matching.
 # May want to include filtering by user and other fields to avoid false positives.
-bk_clients = [client for client in clients 
-              if client.get('client', '').startswith('bk-p4-')]
+bk_clients = [
+    client for client in clients if client.get('client', '').startswith('bk-p4-')
+]
 
 now = datetime.now()
 n_days_ago = (now - timedelta(days=__days_unused__)).timestamp()
-unused_clients = [client for client in bk_clients
-                  if int(client.get('Access')) < n_days_ago]
+unused_clients = [
+    client for client in bk_clients if int(client.get('Access')) < n_days_ago
+]
 
 pprint(unused_clients)
-proceed = input("Will delete %d/%d Buildkite clients. Continue? (y/n) " % (len(unused_clients),len(bk_clients))).lower() == 'y'
+proceed = (
+    input(
+        "Will delete %d/%d Buildkite clients. Continue? (y/n) "
+        % (len(unused_clients), len(bk_clients))
+    ).lower()
+    == 'y'
+)
 
 if proceed:
     for client in unused_clients:

hooks/checkout

@@ -3,17 +3,16 @@ set -eo pipefail
 
 plugin_root="${BASH_SOURCE%/*}/.."
 
-
 # Try to use explicit python3 if its installed
 python_bin="python3"
 if ! [[ -x "$(command -v ${python_bin})" ]]; then
-    python_bin="python"
+  python_bin="python"
 fi
 
 # Ensure some version of virtualenv is installed
 # Lazy install avoids races between different jobs wanting different versions
 if [[ ! $(${python_bin} -m pip freeze) =~ "virtualenv==" ]]; then
-    ${python_bin} -m pip install "virtualenv==16.7.7"
+  ${python_bin} -m pip install "virtualenv==16.7.7"
 fi
 
 # Unique virtualenv for requirements.txt
@@ -22,20 +21,20 @@ venv_dir="${BUILDKITE_BUILD_CHECKOUT_PATH}/../.perforce-plugin-venv-${venv_md5}"
 
 platform=$(${python_bin} -c "import platform; print(platform.system())")
 if [[ "${platform}" == "Windows" ]]; then
-    venv_python_bin="/Scripts/python"
+  venv_python_bin="/Scripts/python"
 else
-    venv_python_bin="/bin/python"
+  venv_python_bin="/bin/python"
 fi
 
 if ! [[ -d "${venv_dir}" ]]; then
-    temp_venv_dir=$(mktemp -d -t perforce-plugin-venv-XXXXXX)
-    trap "rm -rf ${temp_venv_dir}" EXIT
-    ${python_bin} -m virtualenv "${temp_venv_dir}"
-    ${temp_venv_dir}${venv_python_bin} -m pip install -r "${plugin_root}/python/requirements.txt"
-    if ! [[ -d "${venv_dir}" ]]; then # second check to minimize venv init race
-        mv "${temp_venv_dir}" "${venv_dir}"
-    fi
-    echo "virtualenv created at ${venv_dir}"
+  temp_venv_dir=$(mktemp -d -t perforce-plugin-venv-XXXXXX)
+  trap "rm -rf ${temp_venv_dir}" EXIT
+  ${python_bin} -m virtualenv "${temp_venv_dir}"
+  ${temp_venv_dir}${venv_python_bin} -m pip install -r "${plugin_root}/python/requirements.txt"
+  if ! [[ -d "${venv_dir}" ]]; then # second check to minimize venv init race
+    mv "${temp_venv_dir}" "${venv_dir}"
+  fi
+  echo "virtualenv created at ${venv_dir}"
 fi
 
 ${venv_dir}${venv_python_bin} "${plugin_root}/python/checkout.py"

hooks/pre-checkout

@@ -2,28 +2,28 @@
 set -eo pipefail
 
 # Allow sharing of perforce client workspaces for the same stream between pipelines
-if [[ "${BUILDKITE_PLUGIN_PERFORCE_SHARE_WORKSPACE}" == true ]] ; then
-    echo "Workspace sharing enabled"
+if [[ "${BUILDKITE_PLUGIN_PERFORCE_SHARE_WORKSPACE}" == true ]]; then
+  echo "Workspace sharing enabled"
 
-    STREAM="${BUILDKITE_PLUGIN_PERFORCE_STREAM}"
-    if [[ -z "${STREAM}" ]] ; then
-      echo "Error: You must use stream workspaces to enable shared workspaces" >&2
-      exit 1
-    fi
-    if [[ "${BUILDKITE_AGENT_META_DATA_AGENT_COUNT}" -gt 1 ]] ; then
-      echo "Error: You cannot share stream workspaces when running more than one agent" >&2
-      exit 1
-    fi
-    if [[ "${BUILDKITE_PLUGIN_PERFORCE_STREAM_SWITCHING}" == true ]] ; then
-      echo "Stream switching enabled"
-      # Sanitize '//depot/stream-name' to 'depot'
-      SANITIZED_STREAM=$(echo $STREAM | python -c "import sys; print(sys.stdin.read().split('/')[2]);")
-    else # Create a directory per-stream
-      # Sanitize '//depot/stream-name' to '__depot_stream-name'
-      SANITIZED_STREAM=$(echo $STREAM | python -c "import sys; print(sys.stdin.read().replace('/', '_'));")
-    fi
-    # Instead of builds/<agent_number>/<pipeline>, checkout to builds/<stream_name>
-    PERFORCE_CHECKOUT_PATH="${BUILDKITE_BUILD_CHECKOUT_PATH}/../../${SANITIZED_STREAM}"
-    export BUILDKITE_BUILD_CHECKOUT_PATH="${PERFORCE_CHECKOUT_PATH}"
-    echo "Changed BUILDKITE_BUILD_CHECKOUT_PATH to ${PERFORCE_CHECKOUT_PATH}"
-fi
+  STREAM="${BUILDKITE_PLUGIN_PERFORCE_STREAM}"
+  if [[ -z "${STREAM}" ]]; then
+    echo "Error: You must use stream workspaces to enable shared workspaces" >&2
+    exit 1
+  fi
+  if [[ "${BUILDKITE_AGENT_META_DATA_AGENT_COUNT}" -gt 1 ]]; then
+    echo "Error: You cannot share stream workspaces when running more than one agent" >&2
+    exit 1
+  fi
+  if [[ "${BUILDKITE_PLUGIN_PERFORCE_STREAM_SWITCHING}" == true ]]; then
+    echo "Stream switching enabled"
+    # Sanitize '//depot/stream-name' to 'depot'
+    SANITIZED_STREAM=$(echo $STREAM | python -c "import sys; print(sys.stdin.read().split('/')[2]);")
+  else # Create a directory per-stream
+    # Sanitize '//depot/stream-name' to '__depot_stream-name'
+    SANITIZED_STREAM=$(echo $STREAM | python -c "import sys; print(sys.stdin.read().replace('/', '_'));")
+  fi
+  # Instead of builds/<agent_number>/<pipeline>, checkout to builds/<stream_name>
+  PERFORCE_CHECKOUT_PATH="${BUILDKITE_BUILD_CHECKOUT_PATH}/../../${SANITIZED_STREAM}"
+  export BUILDKITE_BUILD_CHECKOUT_PATH="${PERFORCE_CHECKOUT_PATH}"
+  echo "Changed BUILDKITE_BUILD_CHECKOUT_PATH to ${PERFORCE_CHECKOUT_PATH}"
+fi

plugin.yml

@@ -1,3 +1,4 @@
+---
 name: Perforce
 description: Checks out a perforce repository instead of git.
 author: https://github.com/ca-johnson