Merge pull request #11 from AmpersandHQ/add-automated-travis-tests

Add automated travis tests and cherry pick #10

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+.php_cs.cache

.travis.yml

@@ -0,0 +1,65 @@
+language: php
+php: 7.3
+
+env:
+  - TEST_GROUP=latest
+  - TEST_GROUP=two_three_three
+
+install:
+# Composer install
+  - composer install --no-interaction
+# Do a quick code style check
+  - ./vendor/bin/php-cs-fixer fix --dry-run --rules=@PSR2 --diff src/
+# Install magento
+  - if [[ $TEST_GROUP = two_three_three ]]; then  NAME=disablestockres VERSION=2.3.3 . ./vendor/bin/travis-install-magento.sh; fi
+  - if [[ $TEST_GROUP = latest ]];          then  NAME=disablestockres               . ./vendor/bin/travis-install-magento.sh; fi
+# Install this module
+  - cd vendor/ampersand/travis-vanilla-magento/instances/disablestockres
+  - export COMPOSER_MEMORY_LIMIT=-1
+  - composer config repo.disablestockres git "../../../../../"
+  - composer require ampersand/magento2-disable-stock-reservation dev-$TRAVIS_BRANCH || composer require ampersand/magento2-disable-stock-reservation $TRAVIS_BRANCH
+  - php bin/magento setup:upgrade
+# compile magento
+  - php bin/magento setup:di:compile
+# Set up test configuration
+  - magerun2 config:store:set checkout/options/guest_checkout 1
+  - magerun2 config:store:set payment/checkmo/active 1
+  - magerun2 integration:create disablestockres [email protected] https://example.com --access-token="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+  - magerun2 cache:flush
+# warm caches
+  - php bin/magento
+  - cd -
+
+before_install:
+  - mkdir -p $HOME/bin/
+# Install magerun2
+  - test -f $HOME/bin/magerun2 || (wget https://files.magerun.net/n98-magerun2-latest.phar && chmod +x n98-magerun2-latest.phar && mv n98-magerun2-latest.phar $HOME/bin/magerun2)
+
+script:
+  - ADDITIONAL_ARGS="-v"
+  - if [[ $TRAVIS_COMMIT_MESSAGE == *"VERBOSE"* ]]; then ADDITIONAL_ARGS="-vvv"; fi;
+  - ./vendor/bin/codecept build -c dev
+  - URL="https://magento-disablestockres.localhost/" MYSQL_USER="root" MYSQL_HOST="127.0.0.1" MYSQL_DB="databasedisablestockres" MYSQL_PORT="3306" ./vendor/bin/codecept run acceptance -c dev $ADDITIONAL_ARGS
+
+addons:
+  apt:
+    packages:
+    - postfix
+    - apache2
+    - libapache2-mod-fastcgi
+
+services:
+  - mysql
+
+cache:
+  apt: true
+  directories:
+    - $HOME/.composer/cache
+    - $HOME/bin
+
+after_failure:
+  - test -d ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/report/ && for r in ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/report/*; do cat $r; done
+  - test -f ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/log/system.log && grep -v "Broken reference" ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/log/system.log
+  - test -f ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/log/exception.log && cat ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/log/exception.log
+  - test -f ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/log/support_report.log && grep -v "Broken reference" ./vendor/ampersand/travis-vanilla-magento/instances/disablestockres/var/log/support_report.log
+  - sleep 10; # give log files time to render

README.md

@@ -1,5 +1,7 @@
 # AmpersandHQ/magento2-disable-stock-reservation
 
+[![Build Status](https://travis-ci.org/AmpersandHQ/magento2-disable-stock-reservation.svg?branch=master)](https://travis-ci.org/AmpersandHQ/magento2-disable-stock-reservation)
+
 This module disables the inventory reservation logic introduced as part of MSI in Magento 2.3.3 - see 
 https://github.com/magento/inventory/issues/2269 for more information about the way MSI was implemented, and the issues
 that can happen with external WMS integrations.

composer.json

@@ -1,5 +1,6 @@
 {
     "name": "ampersand/magento2-disable-stock-reservation",
+    "description": "This module disables the inventory reservation logic introduced as part of MSI in Magento 2.3.3",
     "type": "magento2-module",
     "minimum-stability": "dev",
     "require": {
@@ -8,10 +9,25 @@
     },
     "autoload": {
         "files": [
-            "registration.php"
+            "src/registration.php"
         ],
         "psr-4": {
-            "Ampersand\\DisableStockReservation\\": ""
+            "Ampersand\\DisableStockReservation\\": "src"
         }
+    },
+    "repositories": [
+        {
+            "type": "composer",
+            "url": "https://repo-magento-mirror.fooman.co.nz/"
+        }
+    ],
+    "require-dev": {
+        "codeception/codeception": "^4.1.1",
+        "codeception/module-phpbrowser": "^1.0.0",
+        "codeception/module-asserts": "^1.1.0",
+        "codeception/module-db": "^1.0.1",
+        "ampersand/travis-vanilla-magento": "^1.0",
+        "codeception/module-rest": "^1.2.0",
+        "friendsofphp/php-cs-fixer": "^2.16"
     }
 }

dev/codeception.MD

@@ -0,0 +1,15 @@
+**Do not run these tests in production, they delete from and insert into your database as well as generate an integration token.**
+
+To run these tests locally you will need to 
+
+1. Install a vanilla magento instance locally
+2. Install this module
+3. `magerun2 config:store:set checkout/options/guest_checkout 1` 
+4. `magerun2 config:store:set payment/checkmo/active 1`
+5. `magerun2 integration:create disablestockres [email protected] https://example.com --access-token="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"`
+6. `magerun2 cache:flush`
+7. Run with the appropriate environment vars set, 
+
+    ```
+    URL="https://magento-disablestockres.localhost/" MYSQL_USER="root" MYSQL_HOST="127.0.0.1" MYSQL_DB="databasedisablestockres" MYSQL_PORT="3306" ./dev/run-codeception.sh
+    ```

dev/codeception.yml

@@ -0,0 +1,15 @@
+paths:
+    tests: tests
+    output: tests/_output
+    data: tests/_data
+    support: tests/_support
+    envs: tests/_envs
+actor_suffix: Tester
+settings:
+    colors: true
+    memory_limit: 1024M
+extensions:
+    enabled:
+        - Codeception\Extension\RunFailed
+params:
+    - env

dev/run-codeception.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+DIR_BASE="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+$DIR_BASE/../vendor/bin/codecept build -c dev
+$DIR_BASE/../vendor/bin/codecept run acceptance -c dev $1 -vvv

dev/tests/_output/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

dev/tests/_support/AcceptanceTester.php

@@ -0,0 +1,27 @@
+<?php
+
+
+/**
+ * Inherited Methods
+ * @method void wantToTest($text)
+ * @method void wantTo($text)
+ * @method void execute($callable)
+ * @method void expectTo($prediction)
+ * @method void expect($prediction)
+ * @method void amGoingTo($argumentation)
+ * @method void am($role)
+ * @method void lookForwardTo($achieveValue)
+ * @method void comment($description)
+ * @method void pause()
+ *
+ * @SuppressWarnings(PHPMD)
+*/
+class AcceptanceTester extends \Codeception\Actor
+{
+    use _generated\AcceptanceTesterActions;
+
+   /**
+    * Define custom actions here
+    */
+    use \Codeception\Lib\Actor\Shared\Retry;
+}

dev/tests/_support/Helper/Acceptance.php

@@ -0,0 +1,56 @@
+<?php
+namespace Helper;
+
+// here you can define custom actions
+// all public methods declared in helper class will be available in $I
+use Codeception\Exception\ModuleException;
+use Symfony\Component\BrowserKit\Cookie;
+
+class Acceptance extends \Codeception\Module
+{
+    /** @var  \Codeception\Module\Db */
+    private $databaseModule;
+
+    /** @var  \Codeception\Module\REST */
+    private $restModule;
+
+    /**
+     * Event hook before a test starts.
+     *
+     * @param \Codeception\TestInterface $test
+     *
+     * @throws \Exception
+     */
+    public function _before(\Codeception\TestInterface $test)
+    {
+        $this->databaseModule = $this->getModule('Db');
+        $this->restModule = $this->getModule('REST');
+    }
+
+    /**
+     * @param $url
+     * @param array $params
+     * @param array $files
+     */
+    public function sendPOSTAndVerifyResponseCodeIs200($url, $params = [], $files = [])
+    {
+        $this->restModule->sendPOST($url, $params, $files);
+        $this->restModule->seeResponseCodeIs(200);
+    }
+
+    /**
+     * Set XDEBUG cookie for debugging rest connections
+     */
+    public function haveRESTXdebugCookie()
+    {
+        $this->restModule->client->getCookieJar()->set(new Cookie('XDEBUG_SESSION', 'phpstorm'));
+    }
+    /**
+     * @param $table
+     * @param $criteria
+     */
+    public function deleteFromDatabase($table, $criteria = [])
+    {
+        $this->databaseModule->_getDriver()->deleteQueryByCriteria($table, $criteria);
+    }
+}

dev/tests/_support/_generated/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

dev/tests/acceptance.suite.yml

@@ -0,0 +1,29 @@
+# Codeception Test Suite Configuration
+#
+# Suite for acceptance tests.
+# Perform tests in browser using the WebDriver or PhpBrowser.
+# If you need both WebDriver and PHPBrowser tests - create a separate suite.
+
+actor: AcceptanceTester
+step_decorators:
+    - \Codeception\Step\Retry
+    - \Codeception\Step\TryTo
+modules:
+    enabled:
+        - PhpBrowser
+        - Asserts
+        - Db
+        - REST
+        - \Helper\Acceptance
+    config:
+        REST:
+           depends: PhpBrowser
+           url: '%URL%rest/'
+           shortDebugResponse: 1000 # only the first 300 chars of the response
+        PhpBrowser:
+            url: '%URL%'
+            timeout: 60
+        Db:
+            dsn: 'mysql:host=%MYSQL_HOST%;dbname=%MYSQL_DB%;port=%MYSQL_PORT%'
+            user: '%MYSQL_USER%'
+            password: