Merge pull request #92 from iMattPro/updates

Update tests and add code coverage

Author: iMattPro

.github/codecov.yml

@@ -0,0 +1,2 @@
+fixes:
+    - "/phpBB3/phpBB/ext/phpbb/googleanalytics/::"

.github/workflows/tests.yml

@@ -25,7 +25,7 @@ jobs:
         strategy:
             matrix:
                 include:
-                    - php: '7.1'
+                    - php: '7.2'
                       db: "none"
                       NOTESTS: 1
 
@@ -113,6 +113,8 @@ jobs:
                       db: "mysql:5.7"
                     - php: '7.2'
                       db: "mysql:5.7"
+                      COVERAGE: 1
+                      db_alias: "mysql:5.7 with Coverage"
                     - php: '7.3'
                       db: "mysql:5.7"
                     - php: '7.4'
@@ -123,6 +125,8 @@ jobs:
                       db: "mysql:5.7"
                     - php: '8.1'
                       db: "mysql:5.7"
+                    - php: '8.2'
+                      db: "mysql:5.7"
 
         name: PHP ${{ matrix.php }} - ${{ matrix.db_alias != '' && matrix.db_alias || matrix.db }}
 
@@ -171,12 +175,21 @@ jobs:
                   echo "::set-output name=db::$db"
 
             - name: Setup PHP
+              if: ${{ matrix.COVERAGE != 1 }}
               uses: shivammathur/setup-php@v2
               with:
                   php-version: ${{ matrix.php }}
                   extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, mysqli, sqlite, pdo_sqlite, intl, gd, exif, iconv, sqlsrv, pdo_sqlsrv, ldap
                   coverage: none
 
+            - name: Setup PHP with Coverage
+              if: ${{ matrix.COVERAGE == 1 }}
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php }}
+                  extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, mysqli, sqlite, pdo_sqlite, intl, gd, exif, iconv, sqlsrv, pdo_sqlsrv, ldap
+                  coverage: xdebug
+
             - name: Setup environment for phpBB
               env:
                   DB: ${{steps.database-type.outputs.db}}
@@ -193,14 +206,36 @@ jobs:
               working-directory: ./phpBB3
 
             - name: Setup PHPUnit files
-              run: mkdir -p phpBB/ext/$EXTNAME/.github && cp .github/phpunit* $_
+              env:
+                  DB: ${{steps.database-type.outputs.db}}
+                  COVERAGE: ${{ matrix.COVERAGE != 1 && '0' || '1' }}
+              run: |
+                  if [ $COVERAGE == '1' ]
+                  then
+                      sed -n '1h;1!H;${;g;s/<\/php>/<\/php>\n\t<filter>\n\t\t<whitelist>\n\t\t\t<directory>..\/<\/directory>\n\t\t\t<exclude>\n\t\t\t\t<directory>..\/tests\/<\/directory>\n\t\t\t\t<directory>..\/language\/<\/directory>\n\t\t\t\t<directory>..\/migrations\/<\/directory>\n\t\t\t<\/exclude>\n\t\t<\/whitelist>\n\t<\/filter>/g;p;}' .github/phpunit-$DB-github.xml &> phpBB/ext/$EXTNAME/.github/phpunit-$DB-github.xml
+                  else
+                      mkdir -p phpBB/ext/$EXTNAME/.github && cp .github/phpunit* $_
+                  fi
               working-directory: ./phpBB3
 
             - name: Run unit tests
               env:
                   DB: ${{steps.database-type.outputs.db}}
-              run: phpBB/vendor/bin/phpunit --configuration phpBB/ext/$EXTNAME/.github/phpunit-$DB-github.xml --bootstrap ./tests/bootstrap.php
+                  COVERAGE: ${{ matrix.COVERAGE != 1 && '0' || '1' }}
+              run: |
+                  if [ $COVERAGE == '1' ]
+                  then
+                      phpBB/vendor/bin/phpunit --configuration phpBB/ext/$EXTNAME/.github/phpunit-$DB-github.xml --bootstrap ./tests/bootstrap.php --coverage-clover build/logs/clover.xml
+                  else
+                      phpBB/vendor/bin/phpunit --configuration phpBB/ext/$EXTNAME/.github/phpunit-$DB-github.xml --bootstrap ./tests/bootstrap.php
+                  fi
               working-directory: ./phpBB3
+
+            - name: Send code coverage
+              if: ${{ matrix.COVERAGE == 1 }}
+              uses: codecov/codecov-action@v1
+              with:
+                  file: ./phpBB3/build/logs/clover.xml
     # END MySQL and MariaDB Job
 
     # START PostgreSQL Job
@@ -221,6 +256,20 @@ jobs:
                       db: "postgres:12"
                     - php: '7.1'
                       db: "postgres:13"
+                    - php: '7.2'
+                      db: "postgres:13"
+                    - php: '7.3'
+                      db: "postgres:13"
+                    - php: '7.4'
+                      db: "postgres:13"
+                    - php: '8.0'
+                      db: "postgres:12"
+                    - php: '8.0'
+                      db: "postgres:13"
+                    - php: '8.1'
+                      db: "postgres:14"
+                    - php: '8.2'
+                      db: "postgres:14"
 
         name: PHP ${{ matrix.php }} - ${{ matrix.db }}
 

README.md

@@ -3,6 +3,7 @@
 A phpBB official extension that allows administrators to easily add Google Analytics to their forums.
 
 [![Build Status](https://github.com/phpbb-extensions/googleanalytics/workflows/Tests/badge.svg)](https://github.com/phpbb-extensions/googleanalytics/actions)
+[![codecov](https://codecov.io/gh/phpbb-extensions/googleanalytics/branch/master/graph/badge.svg?token=1HQh953sBs)](https://codecov.io/gh/phpbb-extensions/googleanalytics)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phpbb-extensions/googleanalytics/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phpbb-extensions/googleanalytics/?branch=master)
 
 ## Install

composer.json

@@ -2,7 +2,7 @@
 	"name": "phpbb/googleanalytics",
 	"type": "phpbb-extension",
 	"description": "A phpBB official extension that allows administrators to easily add Google Analytics to their forums.",
-	"homepage": "https://www.phpbb.com",
+	"homepage": "https://www.phpbb.com/customise/db/extension/googleanalytics/",
 	"version": "1.1.0-dev",
 	"keywords": ["phpbb", "extension", "google", "analytics"],
 	"license": "GPL-2.0-only",

tests/ext_test.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ *
+ * Google Analytics extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2014, 2022 phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+namespace phpbb\googleanalytics\tests\system;
+
+class ext_test extends \phpbb_test_case
+{
+	/** @var \PHPUnit\Framework\MockObject\MockObject|\Symfony\Component\DependencyInjection\ContainerInterface */
+	protected $container;
+
+	/** @var \PHPUnit\Framework\MockObject\MockObject|\phpbb\finder */
+	protected $extension_finder;
+
+	/** @var \PHPUnit\Framework\MockObject\MockObject|\phpbb\db\migrator */
+	protected $migrator;
+
+	/**
+	 * @inheritdoc
+	 */
+	protected function setUp(): void
+	{
+		parent::setUp();
+
+		// Stub the container
+		$this->container = $this->getMockBuilder('\Symfony\Component\DependencyInjection\ContainerInterface')
+			->disableOriginalConstructor()
+			->getMock();
+
+		// Stub the ext finder and disable its constructor
+		$this->extension_finder = $this->getMockBuilder('\phpbb\finder')
+			->disableOriginalConstructor()
+			->getMock();
+
+		// Stub the migrator and disable its constructor
+		$this->migrator = $this->getMockBuilder('\phpbb\db\migrator')
+			->disableOriginalConstructor()
+			->getMock();
+	}
+
+	/**
+	 * Test the extension will be enabled with a compatible version of phpBB
+	 */
+	public function test_enable()
+	{
+		$ext = new \phpbb\googleanalytics\ext($this->container, $this->extension_finder, $this->migrator, 'phpbb/googleanalytics', '');
+
+		self::assertTrue($ext->is_enableable());
+	}
+}