silverstripe / moduleratings

src/Check/CIPassingCheck.php

<?php

namespace SilverStripe\ModuleRatings\Check;

use Exception;
use SilverStripe\ModuleRatings\Check;

class CIPassingCheck extends Check
{
    public function getKey()
    {
        return 'ci_passing';
    }

    public function getDescription()
    {
        return 'Has Travis CI or CircleCI configured and the last build passed successfully (requires slug)';
    }

    public function run()
    {
        // This check requires a repository slug to be provided
        $slug = $this->getSuite()->getRepositorySlug();
        if (!$slug) {
            return;
        }

        $result = $this->checkTravisBuild($slug) || $this->checkCircleCiBuild($slug);
        $this->setSuccessful((bool) $result);
    }

    /**
     * Uses the Travis API to check whether the latest CI build passed
     *
     * @param string $slug
     * @return bool
     */
    protected function checkTravisBuild($slug)
    {
        try {
            $result = $this->getRequestClient()
                ->get('https://api.travis-ci.org/repositories/' . $slug . '.json', $this->getOptions())
                ->getBody();
        } catch (Exception $ex) {
            if ($logger = $this->getSuite()->getLogger()) {
                $logger->debug($ex->getMessage());
            }
            $result = '';
        }

        $response = json_decode($result, true);

        // Fetch failure
        if (!$response) {
            return false;
        }

        // Not set up (404)
        if (isset($response['file']) && $response['file'] === 'not found') {
            return false;
        }

        // Passing?
        if (isset($response['last_build_result']) && (int) $response['last_build_result'] === 0) {
            return true;
        }
        return false;
    }

    /**
     * Return Guzzle options that are specific to Travis CI, if available
     *
     * @return array
     */
    protected function getOptions()
    {
        $options = [];
        if (defined('TRAVIS_CI_TOKEN')) {
            // Note: if you've defined this constant in _ss_environment.php then it will not be available
            // when running this as a Composer plugin
            $options['headers'] = [
                'Authorization' => 'token ' . TRAVIS_CI_TOKEN,

The constant SilverStripe\ModuleRatings\Check\TRAVIS_CI_TOKEN was not found. Maybe you did not declare it correctly or list all dependencies?

            ];
        }
        return $options;
    }

    /**
     * Uses the CircleCI API to check whether the latest CI build passed
     *
     * @param string $slug
     * @return bool
     */
    protected function checkCircleCiBuild($slug)
    {
        try {
            $result = $this->getRequestClient()
                ->get('https://circleci.com/api/v1.1/project/github/' . $slug, [
                    'headers' => ['Accept' => 'application/json'],
                ])
                ->getBody();
        } catch (Exception $ex) {
            if ($logger = $this->getSuite()->getLogger()) {
                $logger->debug($ex->getMessage());
            }
            $result = '';
        }
        $response = json_decode($result, true);

        // Fetch failure
        if (!$response) {
            return false;
        }

        // Not set up (404), e.g. {"message": "Project not found"}
        if (isset($response['message'])) {
            return false;
        }

        // Latest build passing?
        if (isset($response[0]['failed']) && (bool) $response[0]['failed'] === false) {
            return true;
        }
        return false;
    }
}