Merge pull request dokufreaks#363 from dokufreaks/tests

Update Test Framework and fix strftime deprecations

Author: splitbrain

.github/workflows/dokuwiki.yml

@@ -0,0 +1,11 @@
+name: DokuWiki Default Tasks
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '58 6 5 * *'
+
+
+jobs:
+  all:
+    uses: dokuwiki/github-action/.github/workflows/all.yml@main

.github/workflows/phpTestLinux.yml

@@ -0,0 +1,84 @@
+<?php
+
+namespace dokuwiki\plugin\include\test;
+
+use DokuWikiTest;
+
+/**
+ * General tests for the include plugin
+ *
+ * @group plugin_include
+ * @group plugins
+ */
+class GeneralTest extends DokuWikiTest
+{
+    /**
+     * Simple test to make sure the plugin.info.txt is in correct format
+     */
+    public function testPluginInfo(): void
+    {
+        $file = __DIR__ . '/../plugin.info.txt';
+        $this->assertFileExists($file);
+
+        $info = confToHash($file);
+
+        $this->assertArrayHasKey('base', $info);
+        $this->assertArrayHasKey('author', $info);
+        $this->assertArrayHasKey('email', $info);
+        $this->assertArrayHasKey('date', $info);
+        $this->assertArrayHasKey('name', $info);
+        $this->assertArrayHasKey('desc', $info);
+        $this->assertArrayHasKey('url', $info);
+
+        $this->assertEquals('include', $info['base']);
+        $this->assertMatchesRegularExpression('/^https?:\/\//', $info['url']);
+        $this->assertTrue(mail_isvalid($info['email']));
+        $this->assertMatchesRegularExpression('/^\d\d\d\d-\d\d-\d\d$/', $info['date']);
+        $this->assertTrue(false !== strtotime($info['date']));
+    }
+
+    /**
+     * Test to ensure that every conf['...'] entry in conf/default.php has a corresponding meta['...'] entry in
+     * conf/metadata.php.
+     */
+    public function testPluginConf(): void
+    {
+        $conf_file = __DIR__ . '/../conf/default.php';
+        $meta_file = __DIR__ . '/../conf/metadata.php';
+
+        if (!file_exists($conf_file) && !file_exists($meta_file)) {
+            self::markTestSkipped('No config files exist -> skipping test');
+        }
+
+        if (file_exists($conf_file)) {
+            include($conf_file);
+        }
+        if (file_exists($meta_file)) {
+            include($meta_file);
+        }
+
+        $this->assertEquals(
+            gettype($conf),
+            gettype($meta),
+            'Both ' . DOKU_PLUGIN . 'include/conf/default.php and ' . DOKU_PLUGIN . 'include/conf/metadata.php have to exist and contain the same keys.'
+        );
+
+        if ($conf !== null && $meta !== null) {
+            foreach ($conf as $key => $value) {
+                $this->assertArrayHasKey(
+                    $key,
+                    $meta,
+                    'Key $meta[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'include/conf/metadata.php'
+                );
+            }
+
+            foreach ($meta as $key => $value) {
+                $this->assertArrayHasKey(
+                    $key,
+                    $conf,
+                    'Key $conf[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'include/conf/default.php'
+                );
+            }
+        }
+    }
+}

_test/GeneralTest.php

@@ -11,7 +11,7 @@ class syntax_plugin_include_footer extends DokuWiki_Syntax_Plugin {
     function getType() {
         return 'formatting';
     }
-    
+
     function getSort() {
         return 300;
     }
@@ -22,14 +22,14 @@ function handle($match, $state, $pos, Doku_Handler $handler) {
 
     /**
      * Renders a permalink header.
-     * 
+     *
      * Code heavily copied from the header renderer from inc/parser/xhtml.php, just
      * added an href parameter to the anchor tag linking to the wikilink.
      */
     function render($mode, Doku_Renderer $renderer, $data) {
 
         list($page, $sect, $sect_title, $flags, $redirect_id, $footer_lvl) = $data;
-        
+
         if ($mode == 'xhtml') {
             $renderer->doc .= $this->html_footer($page, $sect, $sect_title, $flags, $footer_lvl, $renderer);
 	        return true;
@@ -72,18 +72,18 @@ function html_footer($page, $sect, $sect_title, $flags, $footer_lvl, &$renderer)
         if ($flags['date'] && $exists) {
             $date = $meta['date']['created'];
             if ($date) {
-                $xhtml[] = '<abbr class="published" title="'.strftime('%Y-%m-%dT%H:%M:%SZ', $date).'">'
-                       . strftime($conf['dformat'], $date)
+                $xhtml[] = '<abbr class="published" title="'.dformat($date, '%Y-%m-%dT%H:%M:%SZ').'">'
+                       . dformat($date)
                        . '</abbr>';
             }
         }
-        
+
         // modified date
         if ($flags['mdate'] && $exists) {
             $mdate = $meta['date']['modified'];
             if ($mdate) {
-                $xhtml[] = '<abbr class="published" title="'.strftime('%Y-%m-%dT%H:%M:%SZ', $mdate).'">'
-                       . strftime($conf['dformat'], $mdate)
+                $xhtml[] = '<abbr class="published" title="'.dformat($mdate, '%Y-%m-%dT%H:%M:%SZ').'">'
+                       . dformat($mdate)
                        . '</abbr>';
             }
         }