Merge pull request #865 from PUGX/health-page

added APIs health page

Author: JellyBellyDev

config/routes.yaml

@@ -12,6 +12,10 @@ home:
     defaults:
         repository: "phpunit/phpunit"
 
+health:
+    path: /health
+    controller: App\Controller\HealthController::health
+
 show:
     path: /show/{repository}
     controller: App\Controller\HomeController::index
@@ -36,10 +40,14 @@ search_packagist:
 
 # https://circleci.com/api/v1.1/project/github/PUGX/badge-poser?filter=completed&limit=1
 # https://circleci.com/api/v1.1/project/github/PUGX/badge-poser/tree/release%2Fv3.0.0?filter=completed&limit=1
-circleci_api:
+circleci_api_repository:
     path: /api/v1.1/project/github/{repository}/tree/{branch}
     host: "circleci.com"
     schemes:  [https]
     requirements:
         repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+"
         branch: ".+"
+circleci_api_health:
+    path: /api/v2/me
+    host: "circleci.com"
+    schemes:  [https]

docker-compose.yml

@@ -33,6 +33,7 @@ services:
     env_file:
       - ./.env
       - ./.env.local
+      - ./.env.test
     working_dir: /application
     command: |
       /bin/sh -c "

src/Controller/HealthController.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Controller;
+
+use App\Service\CircleCiClientInterface;
+use App\Service\GitLabClientInterface;
+use Bitbucket\Client as BitbucketClient;
+use Packagist\Api\Client as PackagistClient;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+
+final class HealthController extends AbstractController
+{
+    // sample repo taken from https://github.com/PUGX/badge-poser/issues/337
+    private const BITBUCKET_HEALTHCHECK_WORKSPACE = 'wirbelwild';
+    private const BITBUCKET_HEALTHCHECK_REPO = 'kiwa-core';
+
+    public function health(
+        PackagistClient $packagistClient,
+        CircleCiClientInterface $circleCiClient,
+        GitLabClientInterface $gitlabClient,
+        BitbucketClient $bitbucketClient,
+    ): Response {
+        $packagistPopular = $packagistClient->popular(1);
+        $packagistSuccessRequest = \count($packagistPopular) > 0 && !empty($packagistPopular[0]->getName()) && $packagistPopular[0]->getDownloads() > 0;
+
+        $circleciHealth = \json_decode($circleCiClient->health()->getContent());
+        $circleciSuccessRequest = !empty($circleciHealth) && !empty($circleciHealth->id);
+
+        $gitlabHealth = $gitlabClient->health();
+        $gitlabSuccessRequest = !empty($gitlabHealth) && !empty($gitlabHealth['id']);
+
+        $bitbucketHealth = $bitbucketClient->repositories()->workspaces(self::BITBUCKET_HEALTHCHECK_WORKSPACE)->show(self::BITBUCKET_HEALTHCHECK_REPO);
+        $bitbucketSuccessRequest = !empty($bitbucketHealth) && !empty($bitbucketHealth['full_name']);
+
+        $response = $this->render(
+            'health/index.txt.twig',
+            [
+                'packagist' => $packagistSuccessRequest,
+                'circleci' => $circleciSuccessRequest,
+                'gitlab' => $gitlabSuccessRequest,
+                'bitbucket' => $bitbucketSuccessRequest,
+            ]
+        );
+        $response->headers->set('Content-Type', 'text/plain');
+        $response->setMaxAge(0);
+        $response->setSharedMaxAge(0);
+
+        return $response;
+    }
+}

src/Service/CircleCiClient.php

@@ -14,23 +14,42 @@ public function __construct(private UrlGeneratorInterface $router, private HttpC
     {
     }
 
+    /**
+     * @throws TransportExceptionInterface
+     */
+    public function health(): ResponseInterface
+    {
+        $circleCiApiUrl = $this->router->generate('circleci_api_health');
+
+        return $this->httpClient->request(
+            Request::METHOD_GET,
+            $circleCiApiUrl,
+            [
+                'headers' => [
+                    'Accept' => 'application/json',
+                    'Circle-Token' => $this->circleToken,
+                ],
+            ]
+        );
+    }
+
     /**
      * @throws TransportExceptionInterface
      */
     public function getBuilds(string $repository, string $branch = 'master'): ResponseInterface
     {
-        $circleCiApiUrl = $this->router->generate('circleci_api', ['repository' => $repository, 'branch' => \urlencode($branch)]);
+        $circleCiApiUrl = $this->router->generate('circleci_api_repository', ['repository' => $repository, 'branch' => \urlencode($branch)]);
 
         return $this->httpClient->request(
             Request::METHOD_GET,
             $circleCiApiUrl,
             [
                 'headers' => [
                     'Accept' => 'application/json',
-                    'Content-type' => 'application/json',
+                    'Content-Type' => 'application/json',
+                    'Circle-Token' => $this->circleToken,
                 ],
                 'query' => [
-                    'circle-token' => $this->circleToken,
                     'filter' => 'completed',
                     'limit' => '1',
                 ],

src/Service/CircleCiClientInterface.php

@@ -6,5 +6,7 @@
 
 interface CircleCiClientInterface
 {
+    public function health(): ResponseInterface;
+
     public function getBuilds(string $repository, string $branch = 'master'): ResponseInterface;
 }

src/Service/GitLabClient.php

@@ -12,6 +12,16 @@ public function __construct(private Client $gitlabClient, private string $gitLab
         $this->gitlabClient->authenticate($this->gitLabToken, Client::AUTH_HTTP_TOKEN);
     }
 
+    public function health(): array
+    {
+        $repositoryData = $this->gitlabClient->users()->user();
+        if (!\is_array($repositoryData)) {
+            throw new RepositoryDataNotValid('Repository data not valid: '.\json_encode($repositoryData));
+        }
+
+        return $repositoryData;
+    }
+
     public function show(string $project): array
     {
         $repositoryData = $this->gitlabClient->projects()->show($project);

src/Service/GitLabClientInterface.php

@@ -4,6 +4,9 @@
 
 interface GitLabClientInterface
 {
+    /** @return array<string, mixed> */
+    public function health(): array;
+
     /** @return array<string, mixed> */
     public function show(string $project): array;
 }

templates/health/index.txt.twig

@@ -0,0 +1,4 @@
+packagist: {{ packagist ? 'OK' : 'KO' }}
+circleci:  {{ circleci ? 'OK' : 'KO' }}
+gitlab:    {{ gitlab ? 'OK' : 'KO' }}
+bitbucket: {{ bitbucket ? 'OK' : 'KO' }}