Merge pull request #11 from codebendercc/libtest-updates

fpapadopou · fpapadopou · commit 4fdfcb2fbd5a · 2016-05-05T11:27:48.000+03:00
Payload generation option
diff --git a/Symfony/app/config/config.yml b/Symfony/app/config/config.yml
@@ -3,8 +3,6 @@ imports:
     - { resource: security.yml }
 
 framework:
-    #esi:             ~
-    #translator:      { fallback: "%locale%" }
     secret:          "%secret%"
     router:
         resource: "%kernel.root_dir%/config/routing.yml"
@@ -14,13 +12,24 @@ framework:
     validation:      { enable_annotations: true }
     templating:
         engines: ['twig']
-        #assets_version: SomeVersionScheme
     default_locale:  "%locale%"
     trusted_proxies: ~
     session:         ~
     fragments:       ~
     http_method_override: true
 
+# Services configuration
+services:
+    kernel.listener.auth_listener:
+        class: Codebender\BuilderBundle\EventListener\AuthListener
+        tags:
+            - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 1 }
+        arguments: [ "%authorizationKey%", "%version%" ]
+    kernel.listener.data_validation_listener:
+        class: Codebender\BuilderBundle\EventListener\DataValidationListener
+        tags:
+            - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 0 }
+
 # Twig Configuration
 twig:
     debug:            "%kernel.debug%"
diff --git a/Symfony/src/Codebender/BuilderBundle/Controller/DefaultController.php b/Symfony/src/Codebender/BuilderBundle/Controller/DefaultController.php
@@ -4,13 +4,15 @@
 
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpFoundation\Response;
 
 /**
  * default controller of api bundle
  */
 class DefaultController extends Controller
 {
+    /* @var array $additionalCode */
+    protected $additionalCode = [];
+
     /**
      * status action
      *
@@ -26,36 +28,15 @@ public function statusAction()
      * Gets a request for compilation or library fetching (depends on the 'type' field of the request)
      * and passes the request to either the compiler or the library manager.
      *
-     * Includes several checks in order to ensure the validity of the data provided as well
-     * as authentication.
-     *
-     * @param $authKey
-     * @param $version
      * @return JsonResponse
      */
-    public function handleRequestAction($authKey, $version)
+    public function handleRequestAction()
     {
-        if ($authKey !== $this->container->getParameter('authorizationKey')) {
-            return new JsonResponse(['success' => false, 'message' => 'Invalid authorization key.']);
-        }
+        $contents = json_decode($this->getRequest()->getContent(), true);
 
-        if ($version !== $this->container->getParameter('version')) {
-            return new JsonResponse(['success' => false, 'message' => 'Invalid api version.']);
-        }
-
-        $request = $this->getRequest()->getContent();
-        if (empty($request)) {
-            return new JsonResponse(['success' => false, 'message' => 'Invalid input.']);
-        }
-
-        $contents = json_decode($request, true);
-
-        if (json_last_error() !== JSON_ERROR_NONE) {
-            return new JsonResponse(['success' => false, 'message' => 'Wrong data.']);
-        }
-
-        if (!array_key_exists('data', $contents)) {
-            return new JsonResponse(['success' => false, 'message' => 'Insufficient data provided.']);
+        $isContentValid = $this->isContentValid($contents);
+        if ($isContentValid['success'] !== true) {
+            return new JsonResponse(['success' => false, 'message' => $isContentValid['error']]);
         }
 
         if ($contents['type'] == 'compiler') {
@@ -72,6 +53,15 @@ public function handleRequestAction($authKey, $version)
         ]);
     }
 
+    protected function isContentValid($requestContent)
+    {
+        if (!array_key_exists('data', $requestContent)) {
+            return ['success' => false, 'error' => 'Insufficient data provided.'];
+        }
+
+        return ['success' => true];
+    }
+
     /**
      * Gets the data from the handleRequestAction and proceeds with the compilation
      *
@@ -84,23 +74,11 @@ protected function compile($contents)
     {
         $apiHandler = $this->get('codebender_builder.handler');
 
-        $contents = $this->addUserIdProjectIdIfNotInRequest($contents);
-
-        $files = $contents['files'];
-
-        $userLibraries = [];
-
-        if (array_key_exists('libraries', $contents)) {
-            $userLibraries = $contents['libraries'];
-        }
-
-        $userAndLibmanLibraries = $this->returnProvidedAndFetchedLibraries($files, $userLibraries);
-
-        $contents['libraries'] = $userAndLibmanLibraries['libraries'];
+        $contents = $this->generateCompilerPayload($contents);
 
         $compilerRequestContent = json_encode($contents);
 
-        // perform the actual post to the compiler
+        // perform the actual request to the compiler
         $data = $apiHandler->postRawData($this->container->getParameter('compiler'), $compilerRequestContent);
 
         $decodedResponse = json_decode($data, true);
@@ -112,8 +90,8 @@ protected function compile($contents)
             $decodedResponse['step'] = 'unknown';
         }
 
-        unset($userAndLibmanLibraries['libraries']);
-        $decodedResponse['additionalCode'] = $userAndLibmanLibraries;
+        $decodedResponse['additionalCode'] = $this->additionalCode;
+        $this->additionalCode = [];
 
         return $decodedResponse;
     }
@@ -195,14 +173,66 @@ protected function returnProvidedAndFetchedLibraries($projectFiles, $userLibrari
             $libraries[$header] = $filesToBeAdded;
         }
 
-        return [
-            'libraries' => $libraries,
+        // store info about libraries and headers in the `additionalCode` class property;
+        $this->additionalCode = [
             'providedLibraries' => $providedLibraries,
             'fetchedLibraries' => $librariesFromLibman,
             'detectedHeaders'=> $detectedHeaders,
             'foundHeaders' => $foundHeaders,
             'notFoundHeaders' => $notFoundHeaders
         ];
+
+        return $libraries;
+    }
+
+    /**
+     * Returns the payload used for compilation. Parses projects files and libraries
+     * already existing in request and fetches any necessary libraries from eratosthenes.
+     *
+     * @return JsonResponse
+     */
+    public function generatePayloadAction()
+    {
+        $providedPayload = json_decode($this->getRequest()->getContent(), true);
+
+        $payload = $this->generateCompilerPayload($providedPayload);
+        if (empty($payload)) {
+            return new JsonResponse(['success' => false, 'message' => 'Invalid compilation payload provided.']);
+        }
+
+        $payload['success'] = true;
+        $payload['additionalCode'] = $this->additionalCode;
+        $this->additionalCode = [];
+
+        return new JsonResponse($payload);
+    }
+
+    /**
+     * Returns the payload of a compilation request. Sketch files and board-related
+     * data (build, core, variant) must be provided in the initial payload.
+     *
+     * @param array $providedData
+     * @return array
+     */
+    protected function generateCompilerPayload(array $providedData)
+    {
+        $payload = $this->addUserIdProjectIdIfNotInRequest($providedData);
+
+        if (!array_key_exists('files', $payload)) {
+            return [];
+        }
+
+        $files = $payload['files'];
+
+        $userLibraries = [];
+
+        if (array_key_exists('libraries', $payload)) {
+            $userLibraries = $payload['libraries'];
+        }
+
+        $payload['libraries'] = $this->returnProvidedAndFetchedLibraries($files, $userLibraries);
+
+        return $payload;
     }
 
     /**
diff --git a/Symfony/src/Codebender/BuilderBundle/EventListener/AuthListener.php b/Symfony/src/Codebender/BuilderBundle/EventListener/AuthListener.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Codebender\BuilderBundle\EventListener;
+
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+class AuthListener
+{
+    protected $authorizationKey;
+
+    protected $apiVersion;
+
+    public function __construct($authorizationKey, $apiVersion)
+    {
+        $this->authorizationKey = $authorizationKey;
+        $this->apiVersion = $apiVersion;
+    }
+
+    public function onKernelRequest(GetResponseEvent $event)
+    {
+        $request = $event->getRequest();
+        // don't execute on status action
+        if ($request->get('_route') == 'CodebenderBuilderBundle_status_check') {
+            return;
+        }
+        $providedAuthKey = $request->attributes->get('authKey');
+        $providedApiVersion = $request->attributes->get('version');
+
+        if ($providedAuthKey !== $this->authorizationKey) {
+            $event->setResponse(new JsonResponse(['success' => false, 'message' => 'Invalid authorization key.']));
+            return;
+        }
+
+        if ($providedApiVersion !== $this->apiVersion) {
+            $event->setResponse(new JsonResponse(['success' => false, 'message' => 'Invalid api version.']));
+            return;
+        }
+    }
+}
diff --git a/Symfony/src/Codebender/BuilderBundle/EventListener/DataValidationListener.php b/Symfony/src/Codebender/BuilderBundle/EventListener/DataValidationListener.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Codebender\BuilderBundle\EventListener;
+
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+class DataValidationListener
+{
+    public function onKernelRequest(GetResponseEvent $event)
+    {
+        $request = $event->getRequest();
+        // don't execute on status action
+        if ($request->get('_route') == 'CodebenderBuilderBundle_status_check') {
+            return;
+        }
+        $requestContent = json_decode($request->getContent(), true);
+        if ($requestContent === null || json_last_error() != JSON_ERROR_NONE) {
+            $event->setResponse(new JsonResponse(['success' => false, 'message' => 'Invalid input.']));
+        }
+    }
+}
diff --git a/Symfony/src/Codebender/BuilderBundle/Resources/config/routing.yml b/Symfony/src/Codebender/BuilderBundle/Resources/config/routing.yml
@@ -7,3 +7,9 @@ CodebenderBuilderBundle_handle_request:
     defaults: { _controller: CodebenderBuilderBundle:Default:handleRequest }
     requirements:
       _method: POST
+
+CodebenderBuilderBundle_ganerate_compiler_payload:
+    pattern:    /{authKey}/{version}/payload
+    defaults: { _controller: CodebenderBuilderBundle:Default:generatePayload }
+    requirements:
+      _method: POST
diff --git a/Symfony/src/Codebender/BuilderBundle/Tests/Controller/DefaultControllerFunctionalTest.php b/Symfony/src/Codebender/BuilderBundle/Tests/Controller/DefaultControllerFunctionalTest.php
@@ -21,14 +21,27 @@ public function testStatusAction() {
         $this->assertEquals($client->getResponse()->getContent(), '{"success":true,"status":"OK"}');
     }
 
-    public function testHandleRequestGet() {
+    public function testHandleRequestErrors() {
         $client = static::createClient();
 
         $authorizationKey = $client->getContainer()->getParameter('authorizationKey');
         $apiVersion = $client->getContainer()->getParameter('version');
         $client->request('GET', "/{$authorizationKey}/{$apiVersion}/");
 
         $this->assertEquals($client->getResponse()->getStatusCode(), 405);
+
+        // insufficient data
+        $content = json_encode(['type' => 'compiler']);
+        $response = $this->performPostRequest($content);
+        $this->assertFalse($response['success']);
+        $this->assertEquals('Insufficient data provided.', $response['message']);
+
+        // invalid action requested
+        $content = json_encode(['type' => 'helloooo', 'data' => []]);
+        $response = $this->performPostRequest($content);
+        $this->assertFalse($response['success']);
+        $this->assertEquals('Invalid request type (can handle only \'compiler\' or \'library\' requests)',
+            $response['message']);
     }
 
     public function testHandleRequestCompile() {
@@ -96,4 +109,38 @@ public function testHandleRequestLibraryKeywords() {
         $this->assertArrayHasKey('keywords', $response);
         $this->assertTrue(is_array($response['keywords']));
     }
+
+    public function testGeneratePayloadAction()
+    {
+        $providedContent = '{"files":[{"filename":"project.ino","content":"void setup(){\n\n}\nvoid loop(){\n\n}\n"}],"format":"binary","version":"105","build":{"mcu":"atmega328p","f_cpu":"16000000L","core":"arduino","variant":"standard"}}';
+        $response = $this->performPostRequest($providedContent, 'payload');
+        $this->assertEquals(
+            ['userId', 'projectId', 'files', 'format', 'version', 'build', 'libraries', 'success', 'additionalCode'],
+            array_keys($response)
+        );
+    }
+
+    /**
+     * Performs a POST
+     * @param string $requestContent JSON-encoded POST request content
+     * @param string $uri
+     * @return array
+     */
+    protected function performPostRequest($requestContent, $uri = '')
+    {
+        $client = static::createClient();
+        $authorizationKey = $client->getContainer()->getParameter('authorizationKey');
+        $apiVersion = $client->getContainer()->getParameter('version');
+        $client
+            ->request(
+                'POST',
+                "/{$authorizationKey}/{$apiVersion}/" . $uri,
+                $parameters = [],
+                $files = [],
+                $server = [],
+                $content = $requestContent,
+                $changeHistory = true);
+
+        return json_decode($client->getResponse()->getContent(), true);
+    }
 }
diff --git a/Symfony/src/Codebender/BuilderBundle/Tests/Controller/DefaultControllerUnitTest.php b/Symfony/src/Codebender/BuilderBundle/Tests/Controller/DefaultControllerUnitTest.php
