Merge pull request #24 from udzuki/feat-21-exclude-origin-caliper

feat: Caliperステートメント変換でlogstore_standard_log.originを条件にステートメント変換対象のログを選択

Author: savvan0h

caliper/.env

@@ -21,3 +21,6 @@ APP_NAME=moodle
 APP_URL='http://localhost:8000'
 
 OPENLRW_HOST='openlrw:9966/key/caliper'
+
+# Specify origins to be excluded (e.g. origin1,origin2,...)
+EXCLUDED_ORIGINS=

caliper/Dockerfile

@@ -1,6 +1,6 @@
 FROM composer:1.9 AS builder
 
-LABEL version="2.2.0"
+LABEL version="2.3.0"
 
 WORKDIR /stage
 COPY . .

caliper/app/Commands/Generate.php

@@ -37,6 +37,8 @@ public function handle()
     private function translateEvent()
     {
         $eventCount = env('EVENT_COUNT', 10000);
+        $excludedOrigins = env('EXCLUDED_ORIGINS', '');
+        $excludedOriginsArray = $excludedOrigins === '' ? [] : explode(',', $excludedOrigins);
 
         $executionLog = new ExecutionLog();
         $failedLog = new FailedLog();
@@ -68,6 +70,9 @@ private function translateEvent()
                         ->reject(function ($event) {
                             return $event->userid === 0;
                         })
+                        ->filter(function ($event) use ($excludedOriginsArray) {
+                            return !in_array($event->origin, $excludedOriginsArray);
+                        })
                         ->filter(function ($event) {
                             return is_supported($event->eventname);
                         });

caliper/app/Models/Moodle/Event.php

@@ -87,7 +87,8 @@ public function scopeColumn($query)
             'courseid',
             'relateduserid',
             'other',
-            'timecreated'
+            'timecreated',
+            'origin'
         ]);
     }
 }

caliper/database/seeds/EventSeeder.php

@@ -10,7 +10,8 @@ private function event_factory(
         int $uid = 1,
         string $oTable = null,
         int $oId = null,
-        string $other = null
+        string $other = null,
+        string $origin = null
     ): array {
         return [
             'eventname' => $eventname,
@@ -29,7 +30,8 @@ private function event_factory(
             'relateduserid' => 1,
             'other' => $other,
             'timecreated' => time(),
-            'ip' => '127.0.0.1'
+            'ip' => '127.0.0.1',
+            'origin' => $origin
         ];
     }
 
@@ -76,5 +78,7 @@ public function run(): void
         Event::create($this->event_factory('\core\event\dashboard_viewed'));
         Event::create($this->event_factory('\core\event\user_loggedin', 1, 'user', 1));
         Event::create($this->event_factory('\core\event\user_loggedout', 1, 'user', 1));
+        Event::create($this->event_factory('\core\event\course_viewed', 1, 'user', 1, null, 'origin1'));
+        Event::create($this->event_factory('\core\event\course_viewed', 1, 'user', 1, null, 'origin2'));
     }
 }

caliper/tests/Feature/ExcludedOriginsTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Tests\Feature;
+
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\DB;
+use Tests\TestCase;
+
+final class ExcludedOriginsTest extends TestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->app = $this->createApplication();
+    }
+
+    public function testExcludedOriginsWithParams()
+    {
+        putenv('EXCLUDED_ORIGINS=origin1,origin2');
+        Artisan::call('generate');
+        $this->assertDatabaseHas(
+            'execution_logs',
+            [
+                'id' => 1,
+                'translated' => 13,
+                'failed' => 1,
+                'last_id' => 17,
+            ],
+            'log'
+        );
+    }
+
+    public function testExcludedOriginsWithoutParams()
+    {
+        putenv('EXCLUDED_ORIGINS=');
+        Artisan::call('generate');
+        $this->assertDatabaseHas(
+            'execution_logs',
+            [
+                'id' => 1,
+                'translated' => 15,
+                'failed' => 1,
+                'last_id' => 17,
+            ],
+            'log'
+        );
+    }
+
+    public function tearDown(): void
+    {
+        parent::tearDown();
+        $this->createApplication();
+        DB::connection('log')->table('failed_logs')->truncate();
+        DB::connection('log')->table('execution_logs')->truncate();
+    }
+}

caliper/tests/Feature/LoggingTest.php

@@ -21,9 +21,9 @@ public function testExecutionLog()
             'execution_logs',
             [
                 'id' => 1,
-                'translated' => 13,
+                'translated' => 15,
                 'failed' => 1,
-                'last_id' => 15,
+                'last_id' => 17,
             ],
             'log'
         );