Convert managesieve test scripts to PHPUnit, add them to the suite

plugins/managesieve/tests/Makefile

@@ -1,7 +0,0 @@
-
-clean:
-	rm -f *.log *.php *.diff *.exp *.out
-
-
-test:
-	pear run-tests *.phpt

plugins/managesieve/tests/Parser.php

@@ -0,0 +1,54 @@
+<?php
+
+class Parser extends PHPUnit_Framework_TestCase
+{
+
+    function setUp()
+    {
+        include_once dirname(__FILE__) . '/../lib/rcube_sieve_script.php';
+    }
+
+    /**
+     * Sieve script parsing
+     *
+     * @dataProvider data_parser
+     */
+    function test_parser($input, $output, $message)
+    {
+        $script = new rcube_sieve_script($input);
+        $result = $script->as_text();
+
+        $this->assertEquals(trim($result), trim($output), $message);
+    }
+
+    /**
+     * Data provider for test_parser()
+     */
+    function data_parser()
+    {
+        $dir_path = realpath(dirname(__FILE__) . '/src');
+        $dir      = opendir($dir_path);
+        $result   = array();
+
+        while ($file = readdir($dir)) {
+            if (preg_match('/^[a-z_]+$/', $file)) {
+                $input = file_get_contents($dir_path . '/' . $file);
+
+                if (file_exists($dir_path . '/' . $file . '.out')) {
+                    $output = file_get_contents($dir_path . '/' . $file . '.out');
+                }
+                else {
+                    $output = $input;
+                }
+
+                $result[] = array(
+                    'input'   => $input,
+                    'output'  => $output,
+                    'message' => "Error in parsing '$file' file",
+                );
+            }
+        }
+
+        return $result;
+    }
+}

plugins/managesieve/tests/Tokenizer.php

@@ -0,0 +1,33 @@
+<?php
+
+class Tokenizer extends PHPUnit_Framework_TestCase
+{
+
+    function setUp()
+    {
+        include_once dirname(__FILE__) . '/../lib/rcube_sieve_script.php';
+    }
+
+    function data_tokenizer()
+    {
+        return array(
+            array(1, "text: #test\nThis is test ; message;\nMulti line\n.\n;\n", '"This is test ; message;\nMulti line"'),
+            array(0, '["test1","test2"]', '[["test1","test2"]]'),
+            array(1, '["test"]', '["test"]'),
+            array(1, '"te\\"st"', '"te\\"st"'),
+            array(0, 'test #comment', '["test"]'),
+            array(0, "text:\ntest\n.\ntext:\ntest\n.\n", '["test","test"]'),
+            array(1, '"\\a\\\\\\"a"', '"a\\\\\\"a"'),
+        );
+    }
+
+    /**
+     * @dataProvider data_tokenizer
+     */
+    function test_tokenizer($num, $input, $output)
+    {
+        $res = json_encode(rcube_sieve_script::tokenize($input, $num));
+
+        $this->assertEquals(trim($res), trim($output));
+    }
+}

plugins/managesieve/tests/parser.phpt

@@ -1,120 +0,0 @@
---TEST--
-Main test of script parser
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["fileinto","reject","envelope"];
-# rule:[spam]
-if anyof (header :contains "X-DSPAM-Result" "Spam")
-{
-	fileinto "Spam";
-	stop;
-}
-# rule:[test1]
-if anyof (header :comparator "i;ascii-casemap" :contains ["From","To"] "test@domain.tld")
-{
-	discard;
-	stop;
-}
-# rule:[test2]
-if anyof (not header :comparator "i;octet" :contains ["Subject"] "[test]", header :contains "Subject" "[test2]")
-{
-	fileinto "test";
-	stop;
-}
-# rule:[comments]
-if anyof (true) /* comment
- * "comment" #comment */ {
-    /* comment */ stop;
-# comment
-}
-# rule:[reject]
-if size :over 5000K {
-	reject "Message over 5MB size limit. Please contact me before sending this.";
-}
-# rule:[false]
-if false # size :over 5000K
-{
-	stop; /* rule disabled */
-}
-# rule:[true]
-if true
-{
-	stop;
-}
-fileinto "Test";
-# rule:[address test]
-if address :all :is "From" "nagios@domain.tld"
-{
-	fileinto "domain.tld";
-	stop;
-}
-# rule:[envelope test]
-if envelope :domain :is "From" "domain.tld"
-{
-	fileinto "domain.tld";
-	stop;
-}
-';
-
-$s = new rcube_sieve_script($txt);
-echo $s->as_text();
-
-// -------------------------------------------------------------------------------
-?>
---EXPECT--
-require ["fileinto","reject","envelope"];
-# rule:[spam]
-if header :contains "X-DSPAM-Result" "Spam"
-{
-	fileinto "Spam";
-	stop;
-}
-# rule:[test1]
-if header :contains ["From","To"] "test@domain.tld"
-{
-	discard;
-	stop;
-}
-# rule:[test2]
-if anyof (not header :comparator "i;octet" :contains "Subject" "[test]", header :contains "Subject" "[test2]")
-{
-	fileinto "test";
-	stop;
-}
-# rule:[comments]
-if true
-{
-	stop;
-}
-# rule:[reject]
-if size :over 5000K
-{
-	reject "Message over 5MB size limit. Please contact me before sending this.";
-}
-# rule:[false]
-if false # size :over 5000K
-{
-	stop;
-}
-# rule:[true]
-if true
-{
-	stop;
-}
-fileinto "Test";
-# rule:[address test]
-if address :all :is "From" "nagios@domain.tld"
-{
-	fileinto "domain.tld";
-	stop;
-}
-# rule:[envelope test]
-if envelope :domain :is "From" "domain.tld"
-{
-	fileinto "domain.tld";
-	stop;
-}

plugins/managesieve/tests/parser_body.phpt

@@ -1,49 +0,0 @@
---TEST--
-Test of Sieve body extension (RFC5173)
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["body","fileinto"];
-if body :raw :contains "MAKE MONEY FAST"
-{
-	stop;
-}
-if body :content "text" :contains ["missile","coordinates"]
-{
-	fileinto "secrets";
-}
-if body :content "audio/mp3" :contains ""
-{
-	fileinto "jukebox";
-}
-if body :text :contains "project schedule"
-{
-	fileinto "project/schedule";
-}
-';
-
-$s = new rcube_sieve_script($txt);
-echo $s->as_text();
-
-?>
---EXPECT--
-require ["body","fileinto"];
-if body :raw :contains "MAKE MONEY FAST"
-{
-	stop;
-}
-if body :content "text" :contains ["missile","coordinates"]
-{
-	fileinto "secrets";
-}
-if body :content "audio/mp3" :contains ""
-{
-	fileinto "jukebox";
-}
-if body :text :contains "project schedule"
-{
-	fileinto "project/schedule";
-}

plugins/managesieve/tests/parser_imapflags.phpt

@@ -1,28 +0,0 @@
---TEST--
-Test of Sieve vacation extension (RFC5232)
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["imapflags"];
-# rule:[imapflags]
-if header :matches "Subject" "^Test$" {
-    setflag "\\\\Seen";
-    addflag ["\\\\Answered","\\\\Deleted"];
-}
-';
-
-$s = new rcube_sieve_script($txt, array('imapflags'));
-echo $s->as_text();
-
-?>
---EXPECT--
-require ["imapflags"];
-# rule:[imapflags]
-if header :matches "Subject" "^Test$"
-{
-	setflag "\\Seen";
-	addflag ["\\Answered","\\Deleted"];
-}

plugins/managesieve/tests/parser_include.phpt

@@ -1,30 +0,0 @@
---TEST--
-Test of Sieve include extension
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["include"];
-
-include "script.sieve";
-# rule:[two]
-if true
-{
-    include :optional "second.sieve";
-}
-';
-
-$s = new rcube_sieve_script($txt, array(), array('variables'));
-echo $s->as_text();
-
-?>
---EXPECT--
-require ["include"];
-include "script.sieve";
-# rule:[two]
-if true
-{
-	include :optional "second.sieve";
-}

plugins/managesieve/tests/parser_kep14.phpt

@@ -1,19 +0,0 @@
---TEST--
-Test of Kolab's KEP:14 implementation
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-# EDITOR Roundcube
-# EDITOR_VERSION 123
-';
-
-$s = new rcube_sieve_script($txt, array('body'));
-echo $s->as_text();
-
-?>
---EXPECT--
-# EDITOR Roundcube
-# EDITOR_VERSION 123

plugins/managesieve/tests/parser_prefix.phpt

@@ -1,25 +0,0 @@
---TEST--
-Test of prefix comments handling
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-# this is a comment
-# and the second line
-
-require ["variables"];
-set "b" "c";
-';
-
-$s = new rcube_sieve_script($txt, array(), array('variables'));
-echo $s->as_text();
-
-?>
---EXPECT--
-# this is a comment
-# and the second line
-
-require ["variables"];
-set "b" "c";

plugins/managesieve/tests/parser_relational.phpt

@@ -1,25 +0,0 @@
---TEST--
-Test of Sieve relational extension (RFC5231)
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["relational","comparator-i;ascii-numeric"];
-# rule:[redirect]
-if header :value "ge" :comparator "i;ascii-numeric"
-    ["X-Spam-score"] ["14"] {redirect "test@test.tld";}
-';
-
-$s = new rcube_sieve_script($txt);
-echo $s->as_text();
-
-?>
---EXPECT--
-require ["relational","comparator-i;ascii-numeric"];
-# rule:[redirect]
-if header :value "ge" :comparator "i;ascii-numeric" "X-Spam-score" "14"
-{
-	redirect "test@test.tld";
-}

plugins/managesieve/tests/parser_vacation.phpt

@@ -1,39 +0,0 @@
---TEST--
-Test of Sieve vacation extension (RFC5230)
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["vacation"];
-# rule:[test-vacation]
-if anyof (header :contains "Subject" "vacation")
-{
-	vacation :days 1 text:
-# test
-test test /* test */
-test
-.
-;
-	stop;
-}
-';
-
-$s = new rcube_sieve_script($txt);
-echo $s->as_text();
-
-?>
---EXPECT--
-require ["vacation"];
-# rule:[test-vacation]
-if header :contains "Subject" "vacation"
-{
-	vacation :days 1 text:
-# test
-test test /* test */
-test
-.
-;
-	stop;
-}

plugins/managesieve/tests/parser_variables.phpt

@@ -1,39 +0,0 @@
---TEST--
-Test of Sieve variables extension
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["variables"];
-set "honorific" "Mr";
-set "vacation" text:
-Dear ${HONORIFIC} ${last_name},
-I am out, please leave a message after the meep.
-.
-;
-set :length "b" "${a}";
-set :lower "b" "${a}";
-set :upperfirst "b" "${a}";
-set :upperfirst :lower "b" "${a}";
-set :quotewildcard "b" "Rock*";
-';
-
-$s = new rcube_sieve_script($txt, array(), array('variables'));
-echo $s->as_text();
-
-?>
---EXPECT--
-require ["variables"];
-set "honorific" "Mr";
-set "vacation" text:
-Dear ${HONORIFIC} ${last_name},
-I am out, please leave a message after the meep.
-.
-;
-set :length "b" "${a}";
-set :lower "b" "${a}";
-set :upperfirst "b" "${a}";
-set :upperfirst :lower "b" "${a}";
-set :quotewildcard "b" "Rock*";

plugins/managesieve/tests/parset_subaddress.phpt

@@ -1,38 +0,0 @@
---TEST--
-Test of Sieve subaddress extension (RFC5233)
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt = '
-require ["envelope","subaddress","fileinto"];
-if envelope :user "To" "postmaster"
-{
-	fileinto "postmaster";
-	stop;
-}
-if envelope :detail :is "To" "mta-filters"
-{
-	fileinto "mta-filters";
-	stop;
-}
-';
-
-$s = new rcube_sieve_script($txt);
-echo $s->as_text();
-
-// -------------------------------------------------------------------------------
-?>
---EXPECT--
-require ["envelope","subaddress","fileinto"];
-if envelope :user "To" "postmaster"
-{
-	fileinto "postmaster";
-	stop;
-}
-if envelope :detail :is "To" "mta-filters"
-{
-	fileinto "mta-filters";
-	stop;
-}

plugins/managesieve/tests/src/parser

@@ -0,0 +1,52 @@
+require ["fileinto","reject","envelope"];
+# rule:[spam]
+if anyof (header :contains "X-DSPAM-Result" "Spam")
+{
+	fileinto "Spam";
+	stop;
+}
+# rule:[test1]
+if anyof (header :comparator "i;ascii-casemap" :contains ["From","To"] "test@domain.tld")
+{
+	discard;
+	stop;
+}
+# rule:[test2]
+if anyof (not header :comparator "i;octet" :contains ["Subject"] "[test]", header :contains "Subject" "[test2]")
+{
+	fileinto "test";
+	stop;
+}
+# rule:[comments]
+if anyof (true) /* comment
+ * "comment" #comment */ {
+    /* comment */ stop;
+# comment
+}
+# rule:[reject]
+if size :over 5000K {
+	reject "Message over 5MB size limit. Please contact me before sending this.";
+}
+# rule:[false]
+if false # size :over 5000K
+{
+	stop; /* rule disabled */
+}
+# rule:[true]
+if true
+{
+	stop;
+}
+fileinto "Test";
+# rule:[address test]
+if address :all :is "From" "nagios@domain.tld"
+{
+	fileinto "domain.tld";
+	stop;
+}
+# rule:[envelope test]
+if envelope :domain :is "From" "domain.tld"
+{
+	fileinto "domain.tld";
+	stop;
+}

plugins/managesieve/tests/src/parser.out

@@ -0,0 +1,52 @@
+require ["fileinto","reject","envelope"];
+# rule:[spam]
+if header :contains "X-DSPAM-Result" "Spam"
+{
+	fileinto "Spam";
+	stop;
+}
+# rule:[test1]
+if header :contains ["From","To"] "test@domain.tld"
+{
+	discard;
+	stop;
+}
+# rule:[test2]
+if anyof (not header :comparator "i;octet" :contains "Subject" "[test]", header :contains "Subject" "[test2]")
+{
+	fileinto "test";
+	stop;
+}
+# rule:[comments]
+if true
+{
+	stop;
+}
+# rule:[reject]
+if size :over 5000K
+{
+	reject "Message over 5MB size limit. Please contact me before sending this.";
+}
+# rule:[false]
+if false # size :over 5000K
+{
+	stop;
+}
+# rule:[true]
+if true
+{
+	stop;
+}
+fileinto "Test";
+# rule:[address test]
+if address :all :is "From" "nagios@domain.tld"
+{
+	fileinto "domain.tld";
+	stop;
+}
+# rule:[envelope test]
+if envelope :domain :is "From" "domain.tld"
+{
+	fileinto "domain.tld";
+	stop;
+}

plugins/managesieve/tests/src/parser_body

@@ -0,0 +1,17 @@
+require ["body","fileinto"];
+if body :raw :contains "MAKE MONEY FAST"
+{
+	stop;
+}
+if body :content "text" :contains ["missile","coordinates"]
+{
+	fileinto "secrets";
+}
+if body :content "audio/mp3" :contains ""
+{
+	fileinto "jukebox";
+}
+if body :text :contains "project schedule"
+{
+	fileinto "project/schedule";
+}

plugins/managesieve/tests/src/parser_imapflags

@@ -0,0 +1,7 @@
+require ["imap4flags"];
+# rule:[imapflags]
+if header :matches "Subject" "^Test$"
+{
+	setflag "\\Seen";
+	addflag ["\\Answered","\\Deleted"];
+}

plugins/managesieve/tests/src/parser_include

@@ -0,0 +1,7 @@
+require ["include"];
+include "script.sieve";
+# rule:[two]
+if true
+{
+	include :optional "second.sieve";
+}

plugins/managesieve/tests/src/parser_kep14

@@ -0,0 +1,2 @@
+# EDITOR Roundcube
+# EDITOR_VERSION 123

plugins/managesieve/tests/src/parser_prefix

@@ -0,0 +1,5 @@
+# this is a comment
+# and the second line
+
+require ["variables"];
+set "b" "c";

plugins/managesieve/tests/src/parser_relational

@@ -0,0 +1,6 @@
+require ["relational","comparator-i;ascii-numeric"];
+# rule:[redirect]
+if header :value "ge" :comparator "i;ascii-numeric" "X-Spam-score" "14"
+{
+	redirect "test@test.tld";
+}

plugins/managesieve/tests/src/parser_subaddress

@@ -0,0 +1,11 @@
+require ["envelope","subaddress","fileinto"];
+if envelope :user "To" "postmaster"
+{
+	fileinto "postmaster";
+	stop;
+}
+if envelope :detail :is "To" "mta-filters"
+{
+	fileinto "mta-filters";
+	stop;
+}

plugins/managesieve/tests/src/parser_vacation

@@ -0,0 +1,12 @@
+require ["vacation"];
+# rule:[test-vacation]
+if header :contains "Subject" "vacation"
+{
+	vacation :days 1 text:
+# test
+test test /* test */
+test
+.
+;
+	stop;
+}

plugins/managesieve/tests/src/parser_variables

@@ -0,0 +1,12 @@
+require ["variables"];
+set "honorific" "Mr";
+set "vacation" text:
+Dear ${HONORIFIC} ${last_name},
+I am out, please leave a message after the meep.
+.
+;
+set :length "b" "${a}";
+set :lower "b" "${a}";
+set :upperfirst "b" "${a}";
+set :upperfirst :lower "b" "${a}";
+set :quotewildcard "b" "Rock*";

plugins/managesieve/tests/tokenize.phpt

@@ -1,66 +0,0 @@
---TEST--
-Script parsing: tokenizer
---SKIPIF--
---FILE--
-<?php
-include '../lib/rcube_sieve_script.php';
-
-$txt[1] = array(1, 'text: #test
-This is test ; message;
-Multi line
-.
-;
-');
-$txt[2] = array(0, '["test1","test2"]');
-$txt[3] = array(1, '["test"]');
-$txt[4] = array(1, '"te\\"st"');
-$txt[5] = array(0, 'test #comment');
-$txt[6] = array(0, 'text:
-test
-.
-text:
-test
-.
-');
-$txt[7] = array(1, '"\\a\\\\\\"a"');
-
-foreach ($txt as $idx => $t) {
-    echo "[$idx]---------------\n"; 
-    var_dump(rcube_sieve_script::tokenize($t[1], $t[0]));
-}
-?>
---EXPECT--
-[1]---------------
-string(34) "This is test ; message;
-Multi line"
-[2]---------------
-array(1) {
-  [0]=>
-  array(2) {
-    [0]=>
-    string(5) "test1"
-    [1]=>
-    string(5) "test2"
-  }
-}
-[3]---------------
-array(1) {
-  [0]=>
-  string(4) "test"
-}
-[4]---------------
-string(5) "te"st"
-[5]---------------
-array(1) {
-  [0]=>
-  string(4) "test"
-}
-[6]---------------
-array(2) {
-  [0]=>
-  string(4) "test"
-  [1]=>
-  string(4) "test"
-}
-[7]---------------
-string(4) "a\"a"

tests/HtmlToText.php

@@ -8,7 +8,7 @@
 class HtmlToText extends PHPUnit_Framework_TestCase
 {
 
-    function data()
+    function data_html2text()
     {
         return array(
             0 => array(
@@ -45,7 +45,7 @@ class HtmlToText extends PHPUnit_Framework_TestCase
     }
 
     /**
-     * @dataProvider data
+     * @dataProvider data_html2text
      */
     function test_html2text($title, $in, $out)
     {

tests/phpunit.xml

@@ -29,5 +29,9 @@
             <file>HtmlToText.php</file>
             <file>MailFunc.php</file>
         </testsuite>
+        <testsuite name="managesieve">
+            <file>./../plugins/managesieve/tests/Parser.php</file>
+            <file>./../plugins/managesieve/tests/Tokenizer.php</file>
+        </testsuite>
     </testsuites>
 </phpunit>