Add support for GitHub actions

.github/workflows/blank.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches:
+    tags:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: [7.1, 7.2, 7.3]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Debug if needed
+      run: |
+        export DEBUG=${DEBUG:-false}
+        if [[ "$DEBUG" == "true" ]]; then
+          env
+        fi
+      env:
+        DEBUG: ${{secrets.DEBUG}}
+    - name: Setup php
+      uses: shivammathur/setup-php@1.7.0
+      with:
+        php-version: ${{ matrix.php  }}
+        extension-csv: dom, mbstring
+        coverage: xdebug
+    - name: Get Composer Cache Directory
+      id: composer-cache
+      run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ${{ steps.composer-cache.outputs.dir }}
+        key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+        restore-keys: ${{ runner.os }}-composer-
+    - name: Install dependencies
+      run: composer install
+    - name: Run composer script
+      run: |
+        composer install-dev-tools;
+        composer sca

src/Bundle/CoverallsBundle/Collector/CiEnvVarsCollector.php

@@ -63,6 +63,7 @@ public function collect(array $env)
             ->fillCircleCi()
             ->fillAppVeyor()
             ->fillJenkins()
+            ->fillGithubActions()
             ->fillLocal()
             ->fillRepoToken();
 
@@ -110,6 +111,48 @@ protected function fillTravisCi()
         return $this;
     }
 
+    /**
+     * Fill Github Actions environment variables.
+     *
+     * @return $this
+     */
+    protected function fillGithubActions()
+    {
+        if (!isset($this->env['GITHUB_ACTIONS'])) {
+            return $this;
+        }
+        $this->env['CI_NAME'] = 'github';
+
+        $githubEventName = $this->env['GITHUB_EVENT_NAME'];
+        $githubSha = $this->env['GITHUB_SHA'];
+        $githubRef = $this->env['GITHUB_REF'];
+
+        if (strpos($githubRef, 'refs/heads/') !== false) {
+            $githubRef = str_replace('refs/heads/', '', $githubRef);
+            $jobId = $githubSha;
+        } elseif ($githubEventName === 'pull_request') {
+            $refParts = explode('/', $githubRef);
+            $prNumber = $refParts[2];
+            $this->env['CI_PULL_REQUEST'] = $prNumber;
+            $this->readEnv['CI_PULL_REQUEST'] = $this->env['CI_PULL_REQUEST'];
+            $jobId = sprintf('%s-PR-%s', $githubSha, $prNumber);
+        } elseif (strpos($githubRef, 'refs/tags/') !== false) {
+            $githubRef = str_replace('refs/tags/', '', $githubRef);
+            $jobId = $githubRef;
+        }
+
+        $this->env['CI_JOB_ID'] = $jobId;
+        $this->env['CI_BRANCH'] = $githubRef;
+
+        $this->readEnv['GITHUB_ACTIONS'] = $this->env['GITHUB_ACTIONS'];
+        $this->readEnv['GITHUB_REF'] = $this->env['GITHUB_REF'];
+        $this->readEnv['CI_NAME'] = $this->env['CI_NAME'];
+        $this->readEnv['CI_JOB_ID'] = $this->env['CI_JOB_ID'];
+        $this->readEnv['CI_BRANCH'] = $this->env['CI_BRANCH'];
+
+        return $this;
+    }
+
     /**
      * Fill CircleCI environment variables.
      *

src/Bundle/CoverallsBundle/Collector/GitInfoCollector.php

@@ -74,9 +74,9 @@ protected function collectBranch()
 
         foreach ($branchesResult as $result) {
             if (strpos($result, '* ') === 0) {
-                $exploded = explode('* ', $result, 2);
+                preg_match('~^\* (?:\(HEAD detached at )?([\w/]+)\)?~', $result, $matches);
 
-                return $exploded[1];
+                return $matches[1];
             }
         }
 

src/Bundle/CoverallsBundle/Entity/Exception/RequirementsNotSatisfiedException.php

@@ -72,6 +72,11 @@ public function getHelpMessage()
   - APPVEYOR
   - APPVEYOR_BUILD_NUMBER
 
+For Githib Actions users:
+  - GITHUB_REF
+  - GITHUB_SHA
+  - GITHUB_ACTIONS
+
 From local environment:
 
   - COVERALLS_RUN_LOCALLY

src/Bundle/CoverallsBundle/Entity/JsonFile.php

@@ -547,6 +547,10 @@ protected function ensureJobs()
             return $this;
         }
 
+        if ($this->requireGithubActions()) {
+            return $this;
+        }
+
         if ($this->isUnsupportedServiceJob()) {
             return $this;
         }
@@ -594,6 +598,16 @@ protected function requireRepoToken()
         return $this->serviceName === 'travis-pro' && $this->repoToken !== null;
     }
 
+    /**
+     * Return whether the job requires "service_number", "service_job_id" and "repo_token" (for GithubActions).
+     *
+     * @return bool
+     */
+    protected function requireGithubActions()
+    {
+        return $this->serviceName === 'github' && $this->serviceJobId !== null && $this->repoToken !== null;
+    }
+
     /**
      * Return whether the job is running on unsupported service.
      *

tests/Bundle/CoverallsBundle/Collector/CiEnvVarsCollectorTest.php

@@ -134,6 +134,66 @@ public function shouldCollectJenkinsEnvVars()
         return $object;
     }
 
+    /**
+     * @test
+     */
+    public function shouldCollectGithubActionsEnvVars()
+    {
+        $serviceName = 'github';
+        $jobId = '3fd27e3b7c1ae6a0931d3b637b742440f5eb5011';
+        $gitTag = 'v0.1.1';
+
+        $env = [];
+        $env['COVERALLS_REPO_TOKEN'] = 'token';
+        $env['GITHUB_ACTIONS'] = true;
+        $env['GITHUB_EVENT_NAME'] = 'push';
+        $env['GITHUB_REF'] = 'refs/heads/master';
+        $env['GITHUB_SHA'] = $jobId;
+
+        $object = $this->createCiEnvVarsCollector();
+
+        $actual = $object->collect($env);
+
+        $this->assertArrayHasKey('CI_NAME', $actual);
+        $this->assertSame($serviceName, $actual['CI_NAME']);
+
+        $this->assertArrayHasKey('CI_JOB_ID', $actual);
+        $this->assertSame($jobId, $actual['CI_JOB_ID']);
+
+        $env['GITHUB_REF'] = 'refs/tags/' . $gitTag;
+        $actual = $object->collect($env);
+        $this->assertSame($gitTag, $actual['CI_JOB_ID']);
+
+        return $object;
+    }
+
+    /**
+     * @test
+     */
+    public function shouldCollectGithubActionsEnvVarsForPullRequest()
+    {
+        $serviceName = 'github';
+
+        $env = [];
+        $env['COVERALLS_REPO_TOKEN'] = 'token';
+        $env['GITHUB_ACTIONS'] = true;
+        $env['GITHUB_EVENT_NAME'] = 'pull_request';
+        $env['GITHUB_REF'] = 'refs/pull/1/merge';
+        $env['GITHUB_SHA'] = '3fd27e3b7c1ae6a0931d3b637b742440f5eb5011';
+
+        $object = $this->createCiEnvVarsCollector();
+
+        $actual = $object->collect($env);
+
+        $this->assertArrayHasKey('CI_NAME', $actual);
+        $this->assertSame($serviceName, $actual['CI_NAME']);
+
+        $this->assertArrayHasKey('CI_JOB_ID', $actual);
+        $this->assertSame('3fd27e3b7c1ae6a0931d3b637b742440f5eb5011-PR-1', $actual['CI_JOB_ID']);
+
+        return $object;
+    }
+
     /**
      * @test
      */
@@ -232,6 +292,25 @@ public function shouldHaveReadEnvAfterCollectTravisCiEnvVars(CiEnvVarsCollector
         $this->assertArrayHasKey('CI_NAME', $readEnv);
     }
 
+    /**
+     * @test
+     * @depends shouldCollectGithubActionsEnvVars
+     *
+     * @param CiEnvVarsCollector $object
+     */
+    public function shouldHaveReadEnvAfterCollectGithubActionsEnvVars(CiEnvVarsCollector $object)
+    {
+        $readEnv = $object->getReadEnv();
+
+        $this->assertCount(6, $readEnv);
+        $this->assertArrayHasKey('GITHUB_REF', $readEnv);
+        $this->assertArrayHasKey('CI_NAME', $readEnv);
+        $this->assertArrayHasKey('CI_JOB_ID', $readEnv);
+        $this->assertArrayHasKey('GITHUB_ACTIONS', $readEnv);
+        $this->assertArrayHasKey('CI_BRANCH', $readEnv);
+        $this->assertArrayHasKey('COVERALLS_REPO_TOKEN', $readEnv);
+    }
+
     /**
      * @test
      * @depends shouldCollectTravisProEnvVars

tests/Bundle/CoverallsBundle/Collector/GitInfoCollectorTest.php

@@ -74,6 +74,23 @@ public function shouldCollect()
         $this->assertGit($git);
     }
 
+    /**
+     * @test
+     */
+    public function shouldCollectDetachedRef()
+    {
+        $gitCommand = $this->createGitCommandStubWith(
+            ['* (HEAD detached at pull/1/merge)'],
+            $this->getHeadCommitValue,
+            $this->getRemotesValue
+        );
+        $object = new GitInfoCollector($gitCommand);
+
+        $git = $object->collect();
+
+        $this->assertSame('pull/1/merge', $git->getBranch());
+    }
+
     // collectBranch() exception
 
     /**