Initial commit

Author: KarimGeiger

README.md

@@ -0,0 +1,56 @@
+# Test Rules
+
+Test rules are made to verify that your implementation of SRL is valid.
+These files contain simple tests to validate the SRL and the
+corresponding results. The structure is easy to understand and implement.
+
+## Structure of a .rule File
+
+These rules are required to build valid test rules:
+
+* All files used for testing must end with the extension `.rule` and at
+least contain one valid assertion along with the SRL query.
+* The query is defined through `srl: ` on the beginning of a line.
+* All strings that should match are defined through `match: ` on the
+beginning of a line.
+  * There can be unlimited `match: ` lines per rule.
+  * Each match must be surrounded by `"`.
+* All strings that should **not** match are defined through `no match: `
+on the beginning of a line.
+  * There can be unlimited `no match: ` lines per rule.
+  * Each match must be surrounded by `"`.
+* If a capture group is defined, its result can be defined as follows:
+  * The line must begin with `capture for `.
+  * Surrounded by `"`, the test string to match must be provided, followed by a `: `.
+  * If a named group is desired, use the following syntax: `name: "result"`
+  * If a anonymous group is desired, just supply `"result"`.
+  * Separate multiple captures using `, `.
+  * If one expression returns multiple matches, supply the same test string in the second line.
+* The query as well as the expectations must not exceed one line.
+If required, new lines can be forced using `\n`. Tabs using `\t`.
+* Comments must be on a separate line and start with a `#`.
+
+## Example .rule Files
+
+```
+# This is a sample rule with a named capture group
+srl: capture (letter twice) as "foo"
+capture for "aa1":
+- 0: foo: "aa"
+match: "example"
+match: "aa2"
+no match: "a"
+```
+
+```
+# This is a sample rule with an anonymous capture group and multiple results
+srl: capture (digit)
+capture for "123":
+- 0: 0: "1"
+- 1: 0: "2"
+- 2: 0: "3"
+
+capture for "01":
+- 0: 0: "0"
+- 1: 0: "1"
+```

basename_capture_group.rule

@@ -0,0 +1,7 @@
+# Make sure php internal functions aren't executed while using capture groups
+srl: begin with capture (letter twice) as "basename", must end
+capture for "aa":
+- 0: basename: "aa"
+no match: "a1"
+no match: "aaa"
+match: "bb"

issue_17_uppercase_letter.rule

@@ -0,0 +1,6 @@
+srl: begin with (digit once), any of (letter, digit, uppercase letter) once or more, must end
+match: "1a"
+match: "56"
+match: "8B"
+no match: "abc"
+no match: "1"

literally_spaces.rule

@@ -0,0 +1,4 @@
+# Make sure literal strings are not trimmed.
+srl: literally " foo "
+match: " foo "
+no match: "foo"

sample_capture.rule

@@ -0,0 +1,10 @@
+# This is a sample rule with an anonymous capture group and multiple results
+srl: capture (digit)
+capture for "123":
+- 0: 0: "1"
+- 1: 0: "2"
+- 2: 0: "3"
+
+capture for "01":
+- 0: 0: "0"
+- 1: 0: "1"

website_example_email.rule

@@ -0,0 +1,9 @@
+srl: begin with any of (digit, letter, one of "._%+-") once or more, literally "@", any of (digit, letter, one of ".-") once or more, literally ".", letter at least 2 times, must end, case insensitive
+match: "[email protected]"
+match: "[email protected]"
+match: "[email protected]"
+no match: "[email protected]"
+no match: "you@example"
+no match: "[email protected]"
+no match: "@example.com"
+no match: "example.com"

website_example_email_capture.rule

@@ -0,0 +1,11 @@
+srl: capture (any of (digit, letter, one of "._%+-") once or more) as "local", literally "@", capture (any of (digit, letter, one of ".-") once or more, literally ".", letter at least 2 times ) as "domain", case insensitive
+match: "[email protected], [email protected]"
+no match: "[email protected]"
+no match: "just some text"
+no match: "example.com"
+
+capture for "Message me at [email protected]. Business email: [email protected]":
+- 0: local: "you"
+- 0: domain: "example.com"
+- 1: local: "business"
+- 1: domain: "awesome.email"

website_example_lookahead.rule

@@ -0,0 +1,6 @@
+srl: capture (digit) if not followed by (anything once or more, digit)
+match: "This example contains 3 numbers. 2 should not match. Only 1 should."
+no match: "some string without numbers"
+
+capture for "This example contains 3 numbers. 2 should not match. Only 1 should.":
+- 0: 0: "1"

website_example_password.rule

@@ -0,0 +1,11 @@
+srl: if followed by (anything never or more, letter), if followed by (anything never or more, uppercase letter), if followed by (anything never or more, digit), if followed by (anything never or more, one of "!@#$%^&*[]\"';:_-<>., =+/\\"), anything at least 8 time
+match: "P@sSword1"
+match: "Pass-w0rd"
+match: "Th1s is Secure"
+no match: "Password"
+no match: "P@sS1"
+no match: "justalongpassword"
+no match: "m1ss1ng upper"
+no match: "missing Number"
+no match: "M1SS1NG LOWER"
+no match: "m1ss1ngSpec1al"

website_example_url.rule

@@ -0,0 +1,38 @@
+srl: begin with capture (letter once or more) as "protocol", literally "://", capture ( letter once or more, any of (letter, literally ".") once or more, letter at least 2 times ) as "domain", literally ":" optional, capture (digit once or more) as "port" optional, capture (anything never or more) as "path" until (any of (literally "?", must end)), literally "?" optional, capture (anything never or more) as "parameters" optional, must end, case insensitive
+match: "https://example.domain.com:1234/a/path?query=param"
+match: "http://domain.com?query=param"
+match: "http://domain.com/"
+match: "http://domain.com"
+match: "http://domain/foo/?bar=baz"
+no match: "[email protected]"
+no match: "domain.com"
+no match: "://domain.com"
+no match: "http://"
+
+capture for "https://example.domain.com:1234/a/path?query=param":
+- 0: protocol: "https"
+- 0: domain: "example.domain.com"
+- 0: port: "1234"
+- 0: path: "/a/path"
+- 0: parameters: "query=param"
+
+capture for "https://example.domain.com:1234/a/path":
+- 0: protocol: "https"
+- 0: domain: "example.domain.com"
+- 0: port: "1234"
+- 0: path: "/a/path"
+- 0: parameters: ""
+
+capture for "protocol://domain/a/path":
+- 0: protocol: "protocol"
+- 0: domain: "domain"
+- 0: port: ""
+- 0: path: "/a/path"
+- 0: parameters: ""
+
+capture for "http://domain.com":
+- 0: protocol: "http"
+- 0: domain: "domain.com"
+- 0: port: ""
+- 0: path: ""
+- 0: parameters: ""