chore: add and refactor dev commands (#5861)

googleapis · Mar 28, 2023 · 343d5ac · 343d5ac
1 parent cea265c
commit 343d5ac
Show file tree

Hide file tree

Showing 268 changed files with 2,888 additions and 13,151 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,42 @@
+name: DoxFX Test Suite
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  docfx:
+    name: "Run DocFX tests"
+    runs-on: ubuntu-latest
+    env:
+      PHPDOC_ENV: prod
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+    - run: pip install --require-hashes -r .kokoro/docs/docker/requirements.txt
+    - name: Setup PHP
+      uses: shivammathur/setup-php@verbose
+      with:
+        php-version: "8.0"
+    - name: Extract phpDocumentor
+      id: extract
+      uses: shrink/actions-docker-extract@v2
+      with:
+        image: "phpdoc/phpdoc:202301112131087e6028"
+        path: "/opt/phpdoc/."
+    - name: Symlink phpDocumentor
+      run: ln -s $(pwd)/${{ steps.extract.outputs.destination }}/bin/phpdoc /usr/local/bin/phpdoc
+    - name: Install Dependencies
+      uses: nick-invision/retry@v2
+      with:
+        timeout_minutes: 10
+        max_attempts: 3
+        command: composer --no-interaction --no-ansi --no-progress update -d dev
+    - name: Run DocFX Unit Test Suite
+      run: dev/vendor/bin/phpunit -c dev/phpunit-docfx.xml.dist
+    - name: Run Docs Generator (Dry Run)
+      run: .kokoro/docs/publish.sh
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -0,0 +1,21 @@
+name: CS Test Suite
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    name: PHP Style Check
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.0'
+    - name: "Install dependencies"
+      run: composer global require "squizlabs/php_codesniffer:3.*"
+    - name: Run PHPCS Code Style Checker
+      run: ~/.composer/vendor/bin/phpcs --standard=phpcs-ruleset.xml -p
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -66,55 +66,16 @@ jobs:
     - name: Run Package Test Suites
       run: bash .github/run-package-tests.sh
 
-  style:
+  test_dev_commands:
+    name: Dev Commands Unit Tests
     runs-on: ubuntu-latest
-    name: PHP Style Check
     steps:
     - uses: actions/checkout@v3
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: '8.0'
-    - name: Install Dependencies
-      uses: nick-invision/retry@v2
-      with:
-        timeout_minutes: 10
-        max_attempts: 3
-        command: composer --no-interaction --no-ansi --no-progress update
-    - name: Run PHPCS Code Style Checker
-      run: dev/sh/style
-
-  docfx:
-    name: "Run DocFX tests"
-    runs-on: ubuntu-latest
-    env:
-      PHPDOC_ENV: prod
-    steps:
-    - uses: actions/checkout@v3
-    - name: Setup Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
-    - run: pip install --require-hashes -r .kokoro/docs/docker/requirements.txt
     - name: Setup PHP
       uses: shivammathur/setup-php@verbose
       with:
         php-version: "8.0"
-    - name: Extract phpDocumentor
-      id: extract
-      uses: shrink/actions-docker-extract@v2
-      with:
-        image: "phpdoc/phpdoc:202301112131087e6028"
-        path: "/opt/phpdoc/."
-    - name: Symlink phpDocumentor
-      run: ln -s $(pwd)/${{ steps.extract.outputs.destination }}/bin/phpdoc /usr/local/bin/phpdoc
-    - name: Install Dependencies
-      uses: nick-invision/retry@v2
-      with:
-        timeout_minutes: 10
-        max_attempts: 3
-        command: composer --no-interaction --no-ansi --no-progress update
-    - name: Run DocFX Unit Test Suite
-      run: vendor/bin/phpunit -c dev/phpunit-docfx.xml.dist
-    - name: Run Docs Generator (Dry Run)
-      run: .kokoro/docs/publish.sh
+    - name: "Install dependencies"
+      run: composer  --no-interaction --no-ansi --no-progress update -d dev
+    - name: Run Dev Unit Test Suite
+      run: dev/vendor/bin/phpunit -c dev/phpunit.xml.dist
diff --git a/.kokoro/continuous/run-tests.sh b/.kokoro/continuous/run-tests.sh
@@ -30,9 +30,6 @@ fi
 # non-secret env vars
 export ASSET_TEST_BUCKET="php_asset_test_bucket"
 
-echo "Running PHPCS Code Style Checker"
-dev/sh/style
-
 PHP_VERSION=$(php -r 'echo PHP_MAJOR_VERSION;')
 if [ "5" == $PHP_VERSION ]; then
     # Exclude compute if the PHP version is below 7.0
@@ -50,8 +47,4 @@ echo "Running System Test Suite"
 vendor/bin/phpunit -d memory_limit=512M -c phpunit${PHPUNIT_SUFFIX}-system.xml.dist \
                    --verbose --log-junit ${SYSTEM_LOG_FILENAME}
 
-echo "Running package integration Test"
-
-dev/google-cloud integration -u
-
 popd
diff --git a/.kokoro/docs/publish.sh b/.kokoro/docs/publish.sh
@@ -12,15 +12,15 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 PROJECT_DIR=$(dirname $(dirname $SCRIPT_DIR))
 
 # Run "composer install" if it hasn't been run yet
-if [ ! -d 'vendor/' ]; then
-    composer install -d $PROJECT_DIR
+if [ ! -d 'dev/vendor/' ]; then
+    composer install -d $PROJECT_DIR/dev
 fi
 
 if [ "$STAGING_BUCKET" != "" ]; then
     echo "Using staging bucket ${STAGING_BUCKET}..."
 fi
 
-find $PROJECT_DIR/* -mindepth 1 -maxdepth 1 -name 'composer.json' -not -path '*vendor/*' -exec dirname {} \; | while read DIR
+find $PROJECT_DIR/* -mindepth 1 -maxdepth 1 -name 'composer.json' -not -path '*vendor/*' -regex '[A-Z].*' -exec dirname {} \; | while read DIR
 do
     COMPONENT=$(basename $DIR)
     VERSION=$(cat $DIR/VERSION)

diff --git a/AdvisoryNotifications/composer.json b/AdvisoryNotifications/composer.json
@@ -13,7 +13,7 @@
         "component": {
             "id": "cloud-advisorynotifications",
             "path": "AdvisoryNotifications",
-            "target": "https://github.com/googleapis/google-cloud-php-advisorynotifications"
+            "target": "googleapis/google-cloud-php-advisorynotifications"
         }
     },
     "require": {

diff --git a/CommonProtos/dev/regenerate.sh b/CommonProtos/dev/regenerate.sh
diff --git a/composer.json b/composer.json
@@ -59,17 +59,12 @@
         "phpunit/phpunit": "^4.8|^5.0|^8.0",
         "yoast/phpunit-polyfills": "^1.0",
         "phpspec/prophecy": "^1.10.3",
-        "squizlabs/php_codesniffer": "3.*",
         "phpdocumentor/reflection": "^3.0||^4.0||^5.0",
-        "symfony/console": "^3.0",
         "erusev/parsedown": "^1.6",
-        "vierbergenlars/php-semver": "^3.0",
         "phpseclib/phpseclib": "^2.0||^3.0",
         "google/cloud-tools": "^0.13.0",
         "opis/closure": "^3.0",
-        "swaggest/json-schema": "^0.12.0",
-        "rg/avro-php": "^1.8.0||^2.0.1||^3.0.0",
-        "symfony/yaml": "^3.3||^6.0"
+        "rg/avro-php": "^1.8.0||^2.0.1||^3.0.0"
     },
     "conflict": {
         "psr/log": ">=3"
@@ -568,7 +563,6 @@
             "Google\\Cloud\\DataCatalog\\Lineage\\Tests\\": "DataCatalogLineage/tests",
             "Google\\Cloud\\Datastore\\Tests\\": "Datastore/tests",
             "Google\\Cloud\\Debugger\\Tests\\": "Debugger/tests",
-            "Google\\Cloud\\Dev\\": "dev/src",
             "Google\\Cloud\\ErrorReporting\\Tests\\": "ErrorReporting/tests",
             "Google\\Cloud\\Firestore\\Tests\\": "Firestore/tests",
             "Google\\Cloud\\Language\\Tests\\": "Language/tests",
@@ -596,12 +590,6 @@
             "PubSub/tests/System/testdata/generated/StateProto.php"
         ]
     },
-    "scripts": {
-        "google-cloud": "dev/google-cloud",
-        "style": "dev/sh/style",
-        "style-fix": "dev/sh/style-fix",
-        "tests": "dev/sh/tests"
-    },
     "bin": [
         "Core/bin/google-cloud-batch",
         "Debugger/bin/google-cloud-debugger"

diff --git a/dev/composer.json b/dev/composer.json
@@ -0,0 +1,35 @@
+{
+    "type": "library",
+    "description": "Development commands for the google/cloud library",
+    "require": {
+        "vierbergenlars/php-semver": "^3.0",
+        "symfony/console": " ^3.0",
+        "symfony/yaml": " ^3.3||^6.0",
+        "symfony/process": "^6.0",
+        "google/cloud": "dev-parent",
+        "symfony/filesystem": "^6.0",
+        "twig/twig": "^3.5"
+    },
+    "autoload": {
+        "psr-4": {
+            "Google\\Cloud\\Dev\\": "src"
+        }
+    },
+    "require-dev": {
+        "phpspec/prophecy": "^1.17",
+        "phpunit/phpunit": "4.8|^5.0|^8.0",
+        "swaggest/json-schema": "^0.12.0",
+        "yoast/phpunit-polyfills": "^1.0"
+    },
+    "repositories": {
+        "google-cloud": {
+            "type": "path",
+            "url": "../",
+            "options": {
+                "versions": {
+                    "google/cloud": "dev-parent"
+                }
+            }
+        }
+    }
+}
diff --git a/dev/google-cloud b/dev/google-cloud
@@ -16,16 +16,13 @@
  * limitations under the License.
  */
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
-use Google\Cloud\Dev\AddComponent\Command\AddComponent;
-use Google\Cloud\Dev\ComponentIntegration\Command\ComponentIntegration;
-use Google\Cloud\Dev\ComponentManager;
-use Google\Cloud\Dev\Credentials\Command as Credentials;
-use Google\Cloud\Dev\DocFx\Command\DocFx;
-use Google\Cloud\Dev\Release\Release;
-use Google\Cloud\Dev\ReleaseBuilder\ReleaseBuilder;
-use Google\Cloud\Dev\Split\Command as Split;
+use Google\Cloud\Dev\Command\AddComponentCommand;
+use Google\Cloud\Dev\Command\DocFxCommand;
+use Google\Cloud\Dev\Command\ComponentInfoCommand;
+use Google\Cloud\Dev\Command\ReleaseCommand;
+use Google\Cloud\Dev\Command\SplitCommand;
 use Symfony\Component\Console\Application;
 
 if (!class_exists(Application::class)) {
@@ -38,14 +35,10 @@ if (!class_exists(Application::class)) {
 
 $rootDirectory = realpath(__DIR__ . '/../') . '/';
 
-$componentManager = new ComponentManager($rootDirectory);
-
 $app = new Application;
-$app->add(new AddComponent($rootDirectory));
-$app->add(new ComponentIntegration($rootDirectory));
-$app->add(new Credentials($rootDirectory));
-$app->add(new DocFX($rootDirectory));
-$app->add(new Release($rootDirectory));
-$app->add(new ReleaseBuilder($rootDirectory));
-$app->add(new Split($rootDirectory, $componentManager));
+$app->add(new AddComponentCommand($rootDirectory));
+$app->add(new DocFxCommand());
+$app->add(new ComponentInfoCommand());
+$app->add(new ReleaseCommand($rootDirectory));
+$app->add(new SplitCommand($rootDirectory));
 $app->run();
diff --git a/dev/phpunit-docfx.xml.dist b/dev/phpunit-docfx.xml.dist
@@ -3,6 +3,8 @@
   <testsuites>
     <testsuite name="DocFX Test Suite">
       <directory>./tests/Unit/DocFx</directory>
+      <directory>./tests/Unit/Command/DocFxCommandTest.php</directory>
     </testsuite>
   </testsuites>
 </phpunit>
+
diff --git a/dev/phpunit.xml.dist b/dev/phpunit.xml.dist
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true">
+  <testsuites>
+    <testsuite name="Dev Unit Test Suite">
+      <directory>tests/Unit</directory>
+      <exclude>tests/Unit/DocFx/</exclude>
+      <exclude>tests/Unit/Command/DocFxCommandTest.php</exclude>
+    </testsuite>
+  </testsuites>
+  <filter>
+    <whitelist>
+      <directory suffix=".php">src</directory>
+      <exclude>
+        <directory suffix=".php">src/V[!a-zA-Z]*</directory>
+      </exclude>
+    </whitelist>
+  </filter>
+</phpunit>
diff --git a/dev/sh/style b/dev/sh/style