add some testing scaffolding

Author: thekonz

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true

.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: php-actions/composer@v1
+      - name: PHPUnit Tests
+        uses: php-actions/phpunit@v9
+        with:
+          configuration: test/phpunit.xml

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 composer.lock
 /vendor
+/.phpunit.result.cache

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contribution Guide
+
+1. Make sure to include unit tests
+
+## Unit tests
+
+You can run unit tests locally by executing `make` once
+and then `make test` for consecutive runs (you will need to install docker before).

Dockerfile

@@ -0,0 +1,7 @@
+FROM composer AS composer
+FROM php:7.2-cli
+COPY --from=composer /usr/bin/composer /usr/bin/composer
+WORKDIR /app
+
+RUN apt-get update && \
+    apt-get install -y zip unzip git

Makefile

@@ -0,0 +1,13 @@
+all: build install test
+
+test:
+	docker run -it -v $(shell pwd):/app laravel-scout-mysql-driver vendor/bin/phpunit
+
+install:
+	docker run -it -v $(shell pwd):/app laravel-scout-mysql-driver composer install
+
+bash:
+	docker run -it -v $(shell pwd):/app -it laravel-scout-mysql-driver bash
+
+build:
+	docker build -t laravel-scout-mysql-driver:latest .

composer.json

@@ -12,11 +12,15 @@
             "email": "matt@yabhq.com"
         }
     ],
-    "minimum-stability": "dev",
     "require": {
         "php": "^7.2|^8.0",
         "laravel/scout": "~6.0|~7.0|~8.0"
     },
+    "require-dev": {
+        "phpunit/phpunit": "8.5.x-dev",
+        "laravel/framework": "5.6.* || 5.7.* || 5.8.* || ^6.0 || ^7.0",
+        "mockery/mockery": "^1.3"
+    },
     "autoload": {
         "psr-4": {
             "Yab\\MySQLScout\\": "src/"
@@ -25,6 +29,11 @@
             "src/helpers.php"
         ]
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
     "extra": {
         "laravel": {
             "providers": [

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

tests/TestCase.php

@@ -0,0 +1,31 @@
+<?php
+
+
+namespace Tests;
+
+
+use Illuminate\Config\Repository;
+use PHPUnit\Framework\TestCase as BaseTestCase;
+
+class TestCase extends BaseTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $config = new Repository([
+            'scout' => [
+                'mysql' => [
+                    'mode' => 'NATURAL_LANGUAGE',
+                    'model_directories' => [__DIR__],
+                    'min_search_length' => 0,
+                    'min_fulltext_search_length' => 4,
+                    'min_fulltext_search_fallback' => 'LIKE',
+                    'query_expansion' => false
+                ]
+            ]
+        ]);
+
+        app()->instance('config', $config);
+    }
+}

tests/TestModel.php

@@ -0,0 +1,21 @@
+<?php
+
+
+namespace Tests;
+
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Scout\Searchable;
+
+class TestModel extends Model
+{
+    use Searchable;
+
+    public function toSearchableArray()
+    {
+        return [
+            'first_name' => 'Steve',
+            'last_name' => 'Broski',
+        ];
+    }
+}