Add test target to run tests

Author: atoomic

.dockerignore

@@ -2,18 +2,23 @@
 
 .git
 .gitignore
+
 README.md
-bin/
-blib/
+
 deploy/
 launcher/
-lib/
 local/
-public/
-t/
+
+src/blib/
+src/environments/*docker*
+src/lib/
+src/public/
+src/t/
+src/var/
+src/views/
+
 tools/
-var/
-views/
+
 .env
 *.log
 *.swp

Dockerfile

@@ -5,7 +5,11 @@
 FROM metacpan/metacpan-base:latest AS builder
 SHELL [ "/bin/bash", "-eo", "pipefail", "-c" ]
 
-WORKDIR /metacpan-grep-front-end
+# copy the cpanfile and cpanfile.snapshot
+#   from the current directory to the /cpan directory in the image
+    # and install the dependencies using cpm
+# we could then reuse the cpanfile and cpanfile.snapshot for testing
+WORKDIR /cpan
 
 COPY cpanfile ./
 COPY cpanfile.snapshot ./
@@ -33,6 +37,7 @@ ARG APP_ENV=development
 # Runtime
 ENV APP_ENV=$APP_ENV
 
+# .dockerignore is used to exclude files from the build context
 COPY src/ ./
 
 # always expose a consistent port
@@ -45,3 +50,4 @@ RUN chmod +x docker-entrypoint.sh
 
 # Use the dynamic entrypoint
 ENTRYPOINT ["./docker-entrypoint.sh"]
+CMD ["serve"]

Makefile

@@ -1,11 +1,13 @@
 
-.PHONY: all up-dev up-prod up
+.PHONY: all up-dev up-prod up test t
 
 APP_ENV ?= development
 
 # Add overload config for docker-compose
 ifeq ($(APP_ENV),development)
   COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml
+else ifeq ($(APP_ENV),test)
+  COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml:docker-compose.test.yml
 else
   COMPOSE_FILE=docker-compose.yml
 endif
@@ -15,10 +17,15 @@ all:
 
 up:
 	ln -sf config/docker-compose.$(APP_ENV).env .env
-	APP_ENV=$(APP_ENV) docker compose -f $(subst :, -f ,$(COMPOSE_FILE)) up --build
+	APP_ENV=$(APP_ENV) docker compose -f $(subst :, -f ,$(COMPOSE_FILE)) up --build --exit-code-from grep
 
 up-dev:
 	$(MAKE) up APP_ENV=development
 
 up-prod:
-	$(MAKE) up APP_ENV=production
+	$(MAKE) up APP_ENV=production
+
+t: test
+
+test:
+	$(MAKE) up APP_ENV=test

config/docker-compose.test.env

@@ -0,0 +1,5 @@
+HOST_PORT=5010
+PLACKUP_ARGS='-R lib,bin'
+CPAN_VOLUME_PATH=../metacpan-cpan-extracted-lite
+# only setup for development purpose
+SRC_VOLUME_PATH=./src

docker-compose.test.yml

@@ -0,0 +1,5 @@
+services:
+  grep:
+    command: ["bash", "t/run-tests.sh"]
+    environment:
+      - APP_ENV=test

src/docker-entrypoint.sh

@@ -1,12 +1,17 @@
 #!/bin/bash -e
 
-echo "Starting the application..."
-echo "Environment: $APP_ENV"
-echo "Host Port: $HOST_PORT"
-echo "Plackup Options: $PLACKUP_ARGS"
-echo "git binary: $(which git) - $(git --version)"
-echo "========================="
-echo "Access the application at http://localhost:${HOST_PORT}"
-echo "========================="
+if [ "$1" = "serve" ]; then
+    echo "Starting the application..."
+    echo "Environment: $APP_ENV"
+    echo "Host Port: $HOST_PORT"
+    echo "Plackup Options: $PLACKUP_ARGS"
+    echo "git binary: $(which git) - $(git --version)"
+    echo "========================="
+    echo "Access the application at http://localhost:${HOST_PORT}"
+    echo "========================="
 
-plackup -p 3000 ${PLACKUP_ARGS} bin/app.psgi
+    plackup -p 3000 ${PLACKUP_ARGS} bin/app.psgi
+else
+  echo "Running custom command: $@"
+  exec "$@"
+fi

src/environments/unit-tests.yml

@@ -25,6 +25,6 @@ startup_info: 1
 grepcpan:
    nocache: 0
    maxworkers: 2
-   gitrepo: '/metacpan-cpan-extracted-lite'
+   gitrepo: '/metacpan-cpan-extracted'
    cache:
       directory: '/tmp'

src/lib/GrepCpan/Grep.pm

@@ -462,7 +462,7 @@ sub current_version($self) {
             'cache' => $self->config()->{'cache'}->{'version'},
             'grep'  => eval {
                 scalar Git::Repository->new(
-                    work_tree => $self->root,
+                    work_tree => $self->config()->{'gitrepo'},
                     { git => $self->git_binary }
                 )->run(qw{rev-parse --short HEAD});
             } // '',
@@ -587,6 +587,8 @@ sub _load_cache ( $self, $cache_file ) {
 
 sub _parse_and_check_query_filetype ( $self, $query_filetype, $adjusted_request={} ) {
 
+    return unless length $query_filetype;
+
     my $rules = $self->_parse_query_filetype($query_filetype);
 
     my $r = $rules // [];

src/t/GrepCpan-Grep-dosearch.t

@@ -1,9 +1,10 @@
-#package grepcpan;
-#use Dancer2;
+use v5.36;
 
 use strict;
 use warnings;
 
+local $| = 1;
+
 BEGIN {
     use FindBin;
     unshift @INC, $FindBin::Bin . "/lib";
@@ -50,7 +51,7 @@ my $config = {
         'history_size' => '20'
     },
     'demo'    => '0',
-    'gitrepo' => '~APPDIR~/../metacpan-cpan-extracted-lite',
+    'gitrepo' => '/metacpan-cpan-extracted',
     'limit'   => {
         'distros_per_page'      => '30',
         'files_git_run_bg'      => '2000',
@@ -133,6 +134,7 @@ my $query_looks_sane = validator(
             field search_in_progress => $is_boolean;  # cannot guess the value
             field 'time_elapsed'     => match(qr{^[0-9]+\.[0-9]+});
             field version            => D();
+            field adjusted_request => hash{};
 
         }
     }
@@ -147,25 +149,13 @@ my $queries = [
     'third page'  => { search => 'test', page => 2 },
     'fourth page' => { search => 'test', page => 3 },
 
-    sub { $is_a_known_distro = 1 }, undef,
-    'search distro eBay-API' =>
-        { search => 'test', search_distro => 'eBay-API' },
+    # sub { $is_a_known_distro = 1 }, undef,
+    # 'search distro Try-Tiny' =>
+    #     { search => 'try', search_distro => 'Try-Tiny' },
 ];
 
 my $iterator = natatime 2, @$queries;
 
-# my $query = $grep->do_search(
-#     search => 'test',
-
-#     ## optional search parameters
-#     #page            => 0,
-#     #search_distro   => $qdistro,  # filter on a distribution
-#     #search_file     => $file,
-#     #filetype        => $filetype,
-#     #caseinsensitive => $qci,
-#     #list_files      => $qls,      # not used for now, only impact the view
-# );
-
 while ( my ( $name, $opts ) = $iterator->() ) {
     if ( ref $name eq 'CODE' ) {
 
@@ -175,7 +165,7 @@ while ( my ( $name, $opts ) = $iterator->() ) {
     }
 
     my $query = $grep->do_search(%$opts);
-    is $query, $query_looks_sane, $name;
+    is( $query, $query_looks_sane, $name ) or diag explain $query;
 }
 
 done_testing;

src/t/GrepCpan-Grep-workers.t

@@ -18,7 +18,7 @@ ok -d $tmpdir, "using tmp directory: $tmpdir";
 
 my $config = {
     'maxworkers' => '2',
-    'gitrepo'    => '~APPDIR~/../metacpan-cpan-extracted-lite',
+    'gitrepo'    => '/metacpan-cpan-extracted',
     'cache'      => {
         'directory' => $tmpdir,
         'version'   => "0.$$"