Tested and improved commands for apisearch (#40)

Author: mmoreram

.circleci/config.yml

@@ -0,0 +1,36 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/php:7.1-cli
+      - image: redis:4-alpine
+
+      - image: "docker.elastic.co/elasticsearch/elasticsearch:6.2.4"
+        environment:
+          cluster.name: apisearch
+          http.host: 0.0.0.0
+          transport.host: 0.0.0.0
+          ES_JAVA_OPTS: "-Xms1g -Xmx1g"
+          node.max_local_storage_nodes: 10
+          discovery.type: single-node
+
+      - image: "apisearchio/search-server:latest"
+        environment:
+          APISEARCH_GOD_TOKEN: 0e4d75ba-c640-44c1-a745-06ee51db4e93
+          APISEARCH_READONLY_TOKEN: 410806ed-f2c2-8d22-96ea-7fb68026df34
+          APISEARCH_PING_TOKEN: 6326d504-0a5f-f1ae-7344-8e70b75fcde9
+          APISEARCH_ENABLED_PLUGINS: redis_storage
+          ELASTICSEARCH_HOST: localhost
+          ELASTICSEARCH_PORT: 9200
+          ELASTICSEARCH_REFRESH_ON_WRITE: 1
+          REDIS_STORAGE_HOST: localhost
+          REDIS_STORAGE_PORT: 6379
+
+    working_directory: ~/project
+    steps:
+      - checkout
+      - run:
+          name: Run tests
+          command: |
+            composer install -n --prefer-dist --no-suggest
+            sh .circleci/run-tests

.circleci/run-tests

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+exec 6>&-
+exec 6<&-
+
+until $(curl --output /dev/null --silent --fail "http://localhost:9200/_cluster/health?wait_for_status=yellow&timeout=10s"); do
+    echo "$(date) - can't connect to localhost:9200"
+    sleep 1
+done
+
+exec 6>&-
+exec 6<&-
+
+composer test

.gitignore

@@ -1,3 +1,4 @@
 vendor
 composer.lock
-composer.lock
+composer.lock
+var

.php_cs.cache

@@ -1 +1 @@
-{"php":"7.1.25-1+ubuntu18.04.1+deb.sury.org+1","version":"2.13.2:v2.13.2#ce6c4bbc24302f535c7bbf9ad35fbb0be4f5a4b2","rules":{"blank_line_after_namespace":true,"braces":{"allow_single_line_closure":true},"class_definition":{"single_line":true},"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_constants":true,"lowercase_keywords":true,"method_argument_space":true,"no_break_comment":true,"no_closing_tag":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":true,"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"visibility_required":true,"encoding":true,"full_opening_tag":true,"binary_operator_spaces":true,"blank_line_after_opening_tag":true,"blank_line_before_statement":{"statements":["return"]},"cast_spaces":true,"class_attributes_separation":{"elements":["method"]},"concat_space":{"spacing":"none"},"declare_equal_normalize":true,"function_typehint_space":true,"include":true,"increment_style":true,"lowercase_cast":true,"lowercase_static_reference":true,"magic_constant_casing":true,"magic_method_casing":true,"native_function_casing":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_extra_blank_lines":{"tokens":["curly_brace_block","extra","parenthesis_brace_block","square_brace_block","throw","use"]},"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_around_offset":true,"no_trailing_comma_in_list_call":true,"no_trailing_comma_in_singleline_array":true,"no_unneeded_control_parentheses":true,"no_unneeded_curly_braces":true,"no_unneeded_final_method":true,"no_unused_imports":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"object_operator_without_whitespace":true,"php_unit_fqcn_annotation":true,"phpdoc_align":{"tags":["method","param","property","return","throws","type","var"]},"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_alias_tag":true,"phpdoc_no_empty_return":true,"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_return_self_reference":true,"phpdoc_scalar":true,"phpdoc_separation":true,"phpdoc_single_line_var_spacing":true,"phpdoc_summary":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"protected_to_private":true,"return_type_declaration":true,"semicolon_after_instruction":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_line_comment_style":{"comment_types":["hash"]},"single_quote":true,"space_after_semicolon":{"remove_in_empty_for_expressions":true},"standardize_increment":true,"standardize_not_equals":true,"ternary_operator_spaces":true,"trailing_comma_in_multiline_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"whitespace_after_comma_in_array":true,"yoda_style":true},"hashes":{"Twig\/MethodAccessorExtension.php":2939807874,"Twig\/AggregationTranslationExtension.php":2415810000,"Twig\/UrlBuilderExtension.php":2201893333,"DependencyInjection\/CompilerPass\/ExporterCompilerPass.php":857546720,"DependencyInjection\/CompilerPass\/ReadTransformerCompilerPass.php":3948110591,"DependencyInjection\/CompilerPass\/WriteTransformerCompilerPass.php":2530587380,"DependencyInjection\/CompilerPass\/RepositoryCompilerPass.php":3890663324,"DependencyInjection\/ApisearchExtension.php":112225700,"DependencyInjection\/ApisearchConfiguration.php":1683145073,"ApisearchBundle.php":3640212495,"Translator\/AggregationTranslator.php":3471296845,"Command\/ExportIndexCommand.php":1321012391,"Command\/ImportIndexCommand.php":1581740785,"Command\/PrintTokensCommand.php":1160843383,"Command\/DeleteTokensCommand.php":1800041030,"Command\/ApisearchCommand.php":2188021223,"Command\/ConfigureIndexCommand.php":1879894960,"Command\/ApisearchFormattedCommand.php":1606549717,"Command\/PrintIndicesCommand.php":2173968207,"Command\/AddTokenCommand.php":1932082409,"Command\/WithRepositoryBucketCommand.php":3882313592,"Command\/WithAppRepositoryBucketCommand.php":2106806880,"Command\/DeleteTokenCommand.php":3019199442,"Command\/CreateIndexCommand.php":3363275462,"Command\/DeleteIndexCommand.php":903943328,"Command\/ResetIndexCommand.php":2081910409,"Tests\/Functional\/ProductReadTransformer.php":1666987200,"Tests\/Functional\/DependencyInjection\/DisableCommandsTest.php":4157959069,"Tests\/Functional\/DependencyInjection\/ApisearchConfigurationTest.php":1623406226,"Tests\/Functional\/DependencyInjection\/CompilerPass\/InMemoryRepositoryCompilerPassTest.php":1181469493,"Tests\/Functional\/DependencyInjection\/CompilerPass\/TransformersCompilerPassTest.php":2186592420,"Tests\/Functional\/DependencyInjection\/CompilerPass\/HttpRepositoryCompilerPassTest.php":4000035678,"Tests\/Functional\/DependencyInjection\/EnableCommandsTest.php":4130981515,"Tests\/Functional\/ProductBothTransformer.php":3061253314,"Tests\/Functional\/ProductWriteTransformer.php":4090808924}}
+{"php":"7.1.26-1+ubuntu18.04.1+deb.sury.org+1","version":"2.14.0:v2.14.0#b788ea0af899cedc8114dca7db119c93b6685da2","rules":{"blank_line_after_namespace":true,"braces":{"allow_single_line_closure":true},"class_definition":{"single_line":true},"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_constants":true,"lowercase_keywords":true,"method_argument_space":true,"no_break_comment":true,"no_closing_tag":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":true,"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"visibility_required":true,"encoding":true,"full_opening_tag":true,"binary_operator_spaces":true,"blank_line_after_opening_tag":true,"blank_line_before_statement":{"statements":["return"]},"cast_spaces":true,"class_attributes_separation":{"elements":["method"]},"concat_space":{"spacing":"none"},"declare_equal_normalize":true,"function_typehint_space":true,"include":true,"increment_style":true,"lowercase_cast":true,"lowercase_static_reference":true,"magic_constant_casing":true,"magic_method_casing":true,"native_function_casing":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_extra_blank_lines":{"tokens":["curly_brace_block","extra","parenthesis_brace_block","square_brace_block","throw","use"]},"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_around_offset":true,"no_trailing_comma_in_list_call":true,"no_trailing_comma_in_singleline_array":true,"no_unneeded_control_parentheses":true,"no_unneeded_curly_braces":true,"no_unneeded_final_method":true,"no_unused_imports":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"object_operator_without_whitespace":true,"php_unit_fqcn_annotation":true,"phpdoc_align":{"tags":["method","param","property","return","throws","type","var"]},"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_alias_tag":true,"phpdoc_no_empty_return":true,"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_return_self_reference":true,"phpdoc_scalar":true,"phpdoc_separation":true,"phpdoc_single_line_var_spacing":true,"phpdoc_summary":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_types_order":{"null_adjustment":"always_last","sort_algorithm":"none"},"phpdoc_var_without_name":true,"protected_to_private":true,"return_type_declaration":true,"semicolon_after_instruction":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_line_comment_style":{"comment_types":["hash"]},"single_quote":true,"space_after_semicolon":{"remove_in_empty_for_expressions":true},"standardize_increment":true,"standardize_not_equals":true,"ternary_operator_spaces":true,"trailing_comma_in_multiline_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"whitespace_after_comma_in_array":true,"yoda_style":true},"hashes":{"Twig\/MethodAccessorExtension.php":2939807874,"Twig\/AggregationTranslationExtension.php":2415810000,"Twig\/UrlBuilderExtension.php":2201893333,"DependencyInjection\/CompilerPass\/ExporterCompilerPass.php":857546720,"DependencyInjection\/CompilerPass\/ReadTransformerCompilerPass.php":3948110591,"DependencyInjection\/CompilerPass\/WriteTransformerCompilerPass.php":2530587380,"DependencyInjection\/CompilerPass\/RepositoryCompilerPass.php":2396654015,"DependencyInjection\/ApisearchExtension.php":112225700,"DependencyInjection\/ApisearchConfiguration.php":3701803641,"ApisearchBundle.php":3640212495,"Translator\/AggregationTranslator.php":4238166597,"Command\/ExportIndexCommand.php":1321012391,"Command\/ImportIndexCommand.php":1581740785,"Command\/PrintTokensCommand.php":276913128,"Command\/DeleteTokensCommand.php":1800041030,"Command\/ApisearchCommand.php":2188021223,"Command\/ConfigureIndexCommand.php":1879894960,"Command\/ApisearchFormattedCommand.php":1573978344,"Command\/PrintIndicesCommand.php":2082971206,"Command\/AddTokenCommand.php":3976278823,"Command\/WithRepositoryBucketCommand.php":3882313592,"Command\/WithAppRepositoryBucketCommand.php":3069075073,"Command\/DeleteTokenCommand.php":3019199442,"Command\/CreateIndexCommand.php":244289546,"Command\/DeleteIndexCommand.php":2512043588,"Command\/ResetIndexCommand.php":2081910409,"Tests\/Functional\/ApisearchBundleFunctionalTest.php":3264653550,"Tests\/Functional\/ProductReadTransformer.php":1666987200,"Tests\/Functional\/DependencyInjection\/DisableCommandsTest.php":2956180423,"Tests\/Functional\/DependencyInjection\/ApisearchConfigurationTest.php":271608124,"Tests\/Functional\/DependencyInjection\/CompilerPass\/InMemoryRepositoryCompilerPassTest.php":3052848166,"Tests\/Functional\/DependencyInjection\/CompilerPass\/TransformersCompilerPassTest.php":1388027657,"Tests\/Functional\/DependencyInjection\/CompilerPass\/HttpRepositoryCompilerPassTest.php":2500445244,"Tests\/Functional\/DependencyInjection\/EnableCommandsTest.php":1149363544,"Tests\/Functional\/ProductBothTransformer.php":3061253314,"Tests\/Functional\/Command\/AddDeleteTokensCommandTest.php":67286622,"Tests\/Functional\/Command\/PrintIndicesCommandTest.php":481741707,"Tests\/Functional\/ProductWriteTransformer.php":4090808924}}

.travis.yml

@@ -15,6 +15,8 @@
 
 namespace Apisearch\Command;
 
+use Apisearch\Model\AppUUID;
+use Apisearch\Model\IndexUUID;
 use Apisearch\Model\Token;
 use Apisearch\Model\TokenUUID;
 use Ramsey\Uuid\Uuid;
@@ -48,7 +50,7 @@ protected function configure()
                 Uuid::uuid4()->toString()
             )
             ->addOption(
-                'index',
+                'index-name',
                 null,
                 InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL,
                 'Indices',
@@ -136,16 +138,31 @@ protected function getSuccessMessage(
      */
     protected function runCommand(InputInterface $input, OutputInterface $output)
     {
-        list($app_id, $indices) = $this->getRepositoryAndIndices($input, $output);
+        list($appId, $indices) = $this->getRepositoryAndIndices($input, $output);
         $endpoints = $this->getEndpoints($input, $output);
 
+        $appName = $input->getArgument('app-name');
+        $this->printInfoMessage(
+            $output,
+            $this->getHeader(),
+            "App name: <strong>{$appName}</strong>"
+        );
+
+        $this->printInfoMessage(
+            $output,
+            $this->getHeader(),
+            "App UUID: <strong>{$appId}</strong>"
+        );
+
         $this
             ->repositoryBucket->findRepository($input->getArgument('app-name'))
             ->addToken(
                 new Token(
                     TokenUUID::createById($input->getArgument('uuid')),
-                    (string) $app_id,
-                    $indices,
+                    AppUUID::createById($appId),
+                    array_map(function (string $index) {
+                        return IndexUUID::createById($index);
+                    }, $indices),
                     $input->getOption('http-referrer'),
                     $endpoints,
                     $input->getOption('plugin'),

Command/AddTokenCommand.php

@@ -32,7 +32,7 @@ abstract class ApisearchFormattedCommand extends ApisearchCommand
      * execute() method, you set the code to execute by passing
      * a Closure to the setCode() method.
      *
-     * @return null|int null or 0 if everything went fine, or an error code
+     * @return int|null null or 0 if everything went fine, or an error code
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {

Command/ApisearchFormattedCommand.php

@@ -67,9 +67,9 @@ protected function configure()
                 'App name'
             )
             ->addArgument(
-                'index',
+                'index-name',
                 InputArgument::REQUIRED,
-                'Index'
+                'Index name'
             )
             ->addOption(
                 'language',
@@ -134,7 +134,19 @@ protected function getHeader(): string
     protected function runCommand(InputInterface $input, OutputInterface $output)
     {
         $appName = $input->getArgument('app-name');
-        $indexUUID = IndexUUID::createById($input->getArgument('index'));
+        $indexName = $input->getArgument('index-name');
+        $indexArray = $this
+                ->repositoryBucket
+                ->getConfiguration()[$appName]['indices'] ?? [];
+
+        if (!isset($indexArray[$indexName])) {
+            $this->printInfoMessage(
+                $output,
+                $this->getHeader(),
+                'Index does not exist with this name.'
+            );
+        }
+        $indexId = $indexArray[$indexName];
 
         $this->printInfoMessage(
             $output,
@@ -145,7 +157,7 @@ protected function runCommand(InputInterface $input, OutputInterface $output)
         $this->printInfoMessage(
             $output,
             $this->getHeader(),
-            "Index ID: <strong>{$indexUUID->composeUUID()}</strong>"
+            "Index name: <strong>{$indexName}</strong>"
         );
 
         $synonyms = $this
@@ -161,7 +173,7 @@ protected function runCommand(InputInterface $input, OutputInterface $output)
                 ->repositoryBucket
                 ->findRepository($appName)
                 ->createIndex(
-                    $indexUUID,
+                    IndexUUID::createById($indexId),
                     Config::createFromArray([
                         'language' => $input->getOption('language'),
                         'store_searchable_metadata' => !$input->getOption('no-store-searchable-metadata'),

Command/CreateIndexCommand.php

@@ -40,9 +40,9 @@ protected function configure()
                 'App name'
             )
             ->addArgument(
-                'index',
+                'index-name',
                 InputArgument::REQUIRED,
-                'Index'
+                'Index name'
             );
     }
 
@@ -67,13 +67,24 @@ protected function getHeader(): string
     protected function runCommand(InputInterface $input, OutputInterface $output)
     {
         $appName = $input->getArgument('app-name');
-        $index = $input->getArgument('index');
+        $indexName = $input->getArgument('index-name');
+        $indexArray = $this
+                ->repositoryBucket
+                ->getConfiguration()[$appName]['indices'] ?? [];
+
+        if (!isset($indexArray[$indexName])) {
+            $this->printInfoMessage(
+                $output,
+                $this->getHeader(),
+                'Index does not exist with this name.'
+            );
+        }
 
         try {
             $this
                 ->repositoryBucket
                 ->findRepository($appName)
-                ->deleteIndex(IndexUUID::createById($index));
+                ->deleteIndex(IndexUUID::createById($indexArray[$indexName]));
         } catch (ResourceNotAvailableException $exception) {
             $this->printInfoMessage(
                 $output,