Merge pull request #22 from lukewaite/fix_21_job_name_sanitization

Properly sanitize job names before passing to AWS Batch

Author: lukewaite

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+### Fixed
+* Correct sanitation of job names which previously blocked creation of class based batch jobs
+
 ## v0.2.0 (2017-04-07)
 
 ### Added

composer.json

@@ -8,6 +8,11 @@
       "LukeWaite\\LaravelQueueAwsBatch\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      ":vendor\\:package_name\\": "tests"
+    }
+  },
   "require": {
     "illuminate/support": "~5.1.0",
     "aws/aws-sdk-php": "^3.20.6"

src/Queues/BatchQueue.php

@@ -63,7 +63,7 @@ protected function getDisplayName($job)
     {
         if (is_object($job)) {
             return method_exists($job, 'displayName')
-                ? $job->displayName() : get_class($job);
+                ? $job->displayName() : str_replace('\\', '_', (string)get_class($job));
         } else {
             return is_string($job) ? explode('@', $job)[0] : null;
         }

tests/BatchJobTest.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace LukeWaite\LaravelQueueAwsBatch\Tests;
+
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 

tests/BatchQueueTest.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace LukeWaite\LaravelQueueAwsBatch\Tests;
+
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
@@ -51,6 +53,22 @@ public function testPushProperlyPushesJobOntoDatabase()
         $this->queue->push('foo', ['data']);
     }
 
+    public function testPushProperlySanitizesJobName()
+    {
+        $this->database->shouldReceive('table')->with('table')->andReturn($query = m::mock('StdClass'));
+
+        $query->shouldReceive('insertGetId')->once()->andReturnUsing(function ($array) {
+            return 1;
+        });
+
+        $this->batch->shouldReceive('submitJob')->once()->andReturnUsing(function ($array) {
+            $this->assertRegExp('/^[a-zA-Z0-9_]+$/', $array['jobName']);
+            $this->assertEquals('LukeWaite_LaravelQueueAwsBatch_Tests_TestJob', $array['jobName']);
+        });
+
+        $this->queue->push(new TestJob());
+    }
+
     public function testGetJobById()
     {
         $this->database->shouldReceive('table')->once()->with('table')->andReturn($query = m::mock('StdClass'));
@@ -108,3 +126,8 @@ public function testReleaseWithDelayThrowsException()
         $this->queue->release('default', $job, 10);
     }
 }
+
+class TestJob
+{
+    //
+}