├── .gitignore ├── src ├── Util.fs ├── Das.Test.fsproj └── Library.fs ├── RELEASE_NOTES.md ├── test ├── Das.Test.Test.fsproj ├── ValueTestSuite.fs ├── NumberTests │ ├── FloatTestSuite.fs │ └── IntegerTestSuite.fs ├── ListTestSuite.fs ├── DasTest.fs ├── StringTestSuite.fs └── UtilTestSuite.fs ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .ionide 2 | src/bin 3 | src/obj 4 | 5 | test/bin 6 | test/obj 7 | 8 | src/nupkg 9 | 10 | .fake 11 | nupkg 12 | 13 | NotesAndTest.fsx -------------------------------------------------------------------------------- /src/Util.fs: -------------------------------------------------------------------------------- 1 | namespace Das.Test 2 | 3 | open System.Text.RegularExpressions 4 | 5 | module Util = 6 | let trimWhitespace (str: string) = Regex.Replace(str.Trim(), "\\s+", " ") -------------------------------------------------------------------------------- /RELEASE_NOTES.md: -------------------------------------------------------------------------------- 1 | # Release Notes 2 | 3 | ## 1.1.0 4 | 5 | First release with basic set of test functions. 6 | 7 | ## 1.2.0 8 | 9 | Renamed test type functions like `_string` to `string'`. 10 | 11 | ## 1.3.0 12 | 13 | changed module from Das.Test.Core to Das.Test 14 | 15 | ## 1.4.0 16 | 17 | simplified test type functions 18 | 19 | ## 1.5.0 20 | 21 | added `option` test type 22 | 23 | ## 1.6.0 24 | 25 | corrected error message and added a util function 26 | 27 | ## 1.6.1 28 | 29 | corrected util function name -------------------------------------------------------------------------------- /test/Das.Test.Test.fsproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | Das.Test.Test 6 | Exe 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /test/ValueTestSuite.fs: -------------------------------------------------------------------------------- 1 | module ValueTestSuite 2 | 3 | open Das.Test 4 | 5 | type Point = { 6 | x: int 7 | y: int 8 | } 9 | 10 | type Point with 11 | static member squareDistance point = 12 | (point.x * point.x) + (point.y * point.y) 13 | static member op_GreaterThan (pointA: Point, pointB: Point) = 14 | (pointA |> Point.squareDistance) > (pointB |> Point.squareDistance) 15 | 16 | let pointA = { 17 | x = 1 18 | y = 1 19 | } 20 | 21 | let pointB = { 22 | x = 2 23 | y = 2 24 | } 25 | 26 | let run() = 27 | testSuite 28 | "ValueTestSuite.fs" 29 | [ 30 | unitTest 31 | "Test one value is less than the other" 32 | (fun () -> 33 | [ 34 | verify 35 | "Point A is less than Point B" 36 | (val' pointA |> is lessThan (val' pointB)) 37 | 38 | verify 39 | "Point B is not less than Point A" 40 | (val' pointB |> isNot lessThan (val' pointA)) 41 | ] 42 | ) 43 | ] 44 | -------------------------------------------------------------------------------- /test/NumberTests/FloatTestSuite.fs: -------------------------------------------------------------------------------- 1 | module NumberTests.FloatTestSuite 2 | 3 | open Das.Test 4 | 5 | let run () = 6 | testSuite 7 | "NumberTests.FloatTestSuite.fs" 8 | [ 9 | unitTest 10 | "Test float number is greater than another float number" 11 | (fun () -> 12 | [ 13 | verify 14 | "3.2 is greater than 3.12" 15 | (val' 3.2 |> is greaterThan (val' 3.12)) 16 | 17 | verify 18 | "3.2 is not greater than 3.21" 19 | (val' 3.2 |> isNot greaterThan (val' 3.21)) 20 | ] 21 | ) 22 | 23 | unitTest 24 | "Test float number is less than another float number" 25 | (fun () -> 26 | [ 27 | verify 28 | "3.2 is less than than 3.21" 29 | (val' 3.2 |> is lessThan (val' 3.21)) 30 | 31 | verify 32 | "3.2 is not less than 3.201" 33 | (val' 3.2 |> isNot lessThan (val' 3.19)) 34 | ] 35 | ) 36 | ] -------------------------------------------------------------------------------- /src/Das.Test.fsproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Das.Test 6 | net6.0 7 | Das.Test 8 | true 9 | Copyright 2022 Sumeet Das 10 | Library 11 | 12 | 13 | Das.Test 14 | Das.Test;FSharp;Functional;UnitTesting;Testing;Test 15 | https://raw.githubusercontent.com/sumeetdas/DasTest/master/RELEASE_NOTES.md 16 | https://github.com/sumeetdas/DasTest 17 | AGPL-3.0-or-later 18 | true 19 | git 20 | https://github.com/sumeetdas/DasTest 21 | 22 | 23 | true 24 | true 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /test/ListTestSuite.fs: -------------------------------------------------------------------------------- 1 | module ListTestSuite 2 | 3 | open Das.Test 4 | 5 | let run() = 6 | testSuite 7 | "ListTestSuite.fs" 8 | [ 9 | unitTest 10 | "Test lists are equal" 11 | (fun () -> 12 | [ 13 | verify 14 | "List [1; 2; 3] is equal to list [1; 2; 3]" 15 | (list' [1; 2; 3] |> is equalTo (list' [1; 2; 3])) 16 | 17 | verify 18 | "List [1; 2; 3] is not equal to list [2; 3]" 19 | (list' [1; 2; 3] |> isNot equalTo (list' [2; 3])) 20 | ] 21 | ) 22 | 23 | unitTest 24 | "Test list is empty" 25 | (fun () -> 26 | [ 27 | verify 28 | "List [] is empty" 29 | (list' [] |> is empty __) 30 | 31 | verify 32 | "List [1; 2; 3] is not empty" 33 | (list' [1; 2; 3] |> isNot empty __) 34 | ] 35 | ) 36 | 37 | unitTest 38 | "Test list length is as expected" 39 | (fun () -> 40 | [ 41 | verify 42 | "The length of list [1; 2; 3] is 3" 43 | (list' [1; 2; 3] |> has length 3) 44 | 45 | verify 46 | "The length of list [1; 2; 3] is not 4" 47 | (list' [1; 2; 3] |> doesNotHave length 4) 48 | ] 49 | ) 50 | ] 51 | -------------------------------------------------------------------------------- /test/DasTest.fs: -------------------------------------------------------------------------------- 1 | module DasTest 2 | 3 | open Das.Test 4 | 5 | testSuite 6 | "Das.Test" 7 | [ 8 | unitTest 9 | "Test that the test results are as expected" 10 | (fun () -> 11 | let expectedResult = 12 | """ 13 | 3/3 unit tests passed in test suite `NumberTests.IntegerTestSuite.fs`. 14 | 15 | 2/2 unit tests passed in test suite `NumberTests.FloatTestSuite.fs`. 16 | 17 | 5/5 unit tests passed in test suite `StringTestSuite.fs`. 18 | 19 | 3/3 unit tests passed in test suite `ListTestSuite.fs`. 20 | 21 | 1/1 unit tests passed in test suite `ValueTestSuite.fs`. 22 | 23 | 5/5 unit tests passed in test suite `UtilTestSuite.fs`. 24 | """ 25 | 26 | let actualResult = 27 | [ 28 | NumberTests.IntegerTestSuite.run() 29 | NumberTests.FloatTestSuite.run() 30 | StringTestSuite.run() 31 | ListTestSuite.run() 32 | ValueTestSuite.run() 33 | UtilTestSuite.run() 34 | ] 35 | |> String.concat "\n" 36 | 37 | let processString (str: string) = 38 | str.Trim().Split "\n" 39 | |> Array.map (fun str -> str.Trim()) 40 | |> Array.filter (fun str -> not (str.Length = 0)) 41 | |> String.concat "\n" 42 | 43 | let expectedResult = expectedResult |> processString 44 | let actualResult = actualResult |> processString 45 | 46 | [ 47 | verify 48 | "Test result is same as expected" 49 | (val' actualResult |> is equalTo (val' expectedResult)) 50 | ] 51 | ) 52 | ] 53 | |> printfn "%s" 54 | -------------------------------------------------------------------------------- /test/NumberTests/IntegerTestSuite.fs: -------------------------------------------------------------------------------- 1 | module NumberTests.IntegerTestSuite 2 | 3 | open Das.Test 4 | 5 | let run () = 6 | testSuite 7 | "NumberTests.IntegerTestSuite.fs" 8 | [ 9 | unitTest 10 | "Test an integer is equal to another integer" 11 | (fun () -> 12 | let num = 4 13 | 14 | [ 15 | verify 16 | "3 is equal to 3" 17 | (val' 3 |> is equalTo (val' 3)) 18 | 19 | verify 20 | "3 is not equal to 4" 21 | (val' 3 |> isNot equalTo (val' 4)) 22 | 23 | verify 24 | "num is equal to 4" 25 | (val' num |> is equalTo (val' 4)) 26 | ] 27 | ) 28 | 29 | unitTest 30 | "Test an integer is greater than another integer" 31 | (fun () -> 32 | [ 33 | verify 34 | "3 is greater than 2" 35 | (val' 3 |> is greaterThan (val' 2)) 36 | 37 | verify 38 | "3 is not greater than than 4" 39 | (val' 3 |> isNot greaterThan (val' 4)) 40 | ] 41 | ) 42 | 43 | unitTest 44 | "Test an integer is less than or equal to another integer" 45 | (fun () -> 46 | [ 47 | verify 48 | "3 is less than or equal to 3" 49 | (val' 3 |> is lessThanOrEqualTo (val' 3)) 50 | 51 | verify 52 | "3 is less than or equal to 4" 53 | (val' 3 |> is lessThanOrEqualTo (val' 4)) 54 | 55 | verify 56 | "3 is not less than or equal to 2" 57 | (val' 3 |> isNot lessThanOrEqualTo (val' 2)) 58 | ] 59 | ) 60 | ] -------------------------------------------------------------------------------- /test/StringTestSuite.fs: -------------------------------------------------------------------------------- 1 | module StringTestSuite 2 | 3 | open Das.Test 4 | 5 | let run () = 6 | testSuite 7 | "StringTestSuite.fs" 8 | [ 9 | unitTest 10 | "Test strings are equal" 11 | (fun () -> 12 | [ 13 | verify 14 | "\"jpeg\" is equal to \"jpeg\"" 15 | (val' "jpeg" |> is equalTo (val' "jpeg")) 16 | 17 | verify 18 | "\"jpeg\" isNot equal to \"peg\"" 19 | (val' "jpeg" |> isNot equalTo (val' "peg")) 20 | ] 21 | ) 22 | 23 | unitTest 24 | "Test string contains another string" 25 | (fun () -> 26 | [ 27 | verify 28 | "\"banana\" contains \"ana\"" 29 | (val' "banana" |> does contain (val' "ana")) 30 | 31 | verify 32 | "\"banana\" does not contains \"xyz\"" 33 | (val' "banana" |> doesNot contain (val' "xyz")) 34 | ] 35 | ) 36 | 37 | unitTest 38 | "Test string starts with another string" 39 | (fun () -> 40 | [ 41 | verify 42 | "\"banana\" does start with \"ban\"" 43 | (val' "banana" |> does startWith (val' "ban")) 44 | 45 | verify 46 | "\"banana\" does not start with \"ana\"" 47 | (val' "banana" |> doesNot startWith (val' "ana")) 48 | ] 49 | ) 50 | 51 | unitTest 52 | "Test string ends with another string" 53 | (fun () -> 54 | [ 55 | verify 56 | "\"banana\" contains \"ana\"" 57 | (val' "banana" |> does endWith (val' "ana")) 58 | 59 | verify 60 | "\"banana\" does not end with \"xyz\"" 61 | (val' "banana" |> does endWith (val' "ana")) 62 | ] 63 | ) 64 | 65 | unitTest 66 | "Test string is empty" 67 | (fun () -> 68 | [ 69 | verify 70 | "\"\" is empty" 71 | (val' "" |> is empty __) 72 | 73 | verify 74 | "\"banana\" is not empty" 75 | (val' "banana" |> isNot empty __) 76 | ] 77 | ) 78 | ] -------------------------------------------------------------------------------- /test/UtilTestSuite.fs: -------------------------------------------------------------------------------- 1 | module UtilTestSuite 2 | 3 | open Das.Test 4 | open Das.Test.Util 5 | 6 | let run () = 7 | testSuite 8 | "UtilTestSuite.fs" 9 | [ 10 | unitTest 11 | "Test strings are equal" 12 | (fun () -> 13 | let input = """ 14 | Hello There! 15 | Hi There! 16 | """ 17 | 18 | let expected = "Hello There! Hi There!" 19 | 20 | let actual = input |> trimWhitespace 21 | 22 | let result1 = 23 | verify 24 | "'actual' string is equal to 'expected' string" 25 | (val' actual |> is equalTo (val' expected)) 26 | 27 | let input = """ 28 | 29 | Hello There! 30 | 31 | 5 32 | 33 | Hi There! 34 | 35 | """ 36 | 37 | let expected = "Hello There! 5 Hi There!" 38 | 39 | let actual = input |> trimWhitespace 40 | 41 | let result2 = 42 | verify 43 | "'actual' string is equal to 'expected' string" 44 | (val' actual |> is equalTo (val' expected)) 45 | 46 | [ 47 | result1 48 | 49 | verify 50 | "\"jpeg\" isNot equal to \"peg\"" 51 | (val' "jpeg" |> isNot equalTo (val' "peg")) 52 | ] 53 | ) 54 | 55 | unitTest 56 | "Test string contains another string" 57 | (fun () -> 58 | [ 59 | verify 60 | "\"banana\" contains \"ana\"" 61 | (val' "banana" |> does contain (val' "ana")) 62 | 63 | verify 64 | "\"banana\" does not contains \"xyz\"" 65 | (val' "banana" |> doesNot contain (val' "xyz")) 66 | ] 67 | ) 68 | 69 | unitTest 70 | "Test string starts with another string" 71 | (fun () -> 72 | [ 73 | verify 74 | "\"banana\" does start with \"ban\"" 75 | (val' "banana" |> does startWith (val' "ban")) 76 | 77 | verify 78 | "\"banana\" does not start with \"ana\"" 79 | (val' "banana" |> doesNot startWith (val' "ana")) 80 | ] 81 | ) 82 | 83 | unitTest 84 | "Test string ends with another string" 85 | (fun () -> 86 | [ 87 | verify 88 | "\"banana\" contains \"ana\"" 89 | (val' "banana" |> does endWith (val' "ana")) 90 | 91 | verify 92 | "\"banana\" does not end with \"xyz\"" 93 | (val' "banana" |> does endWith (val' "ana")) 94 | ] 95 | ) 96 | 97 | unitTest 98 | "Test string is empty" 99 | (fun () -> 100 | [ 101 | verify 102 | "\"\" is empty" 103 | (val' "" |> is empty __) 104 | 105 | verify 106 | "\"banana\" is not empty" 107 | (val' "banana" |> isNot empty __) 108 | ] 109 | ) 110 | ] -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Das.Test 2 | 3 | An opinionated unit testing library written in F# for F#. 4 | 5 | # Goals 6 | 7 | * The unit testing library should work and should not exit giving some obscure error. 8 | 9 | * The library should not expect user to know C# and dotnet (except for basic stuff to make your F# project run), and should document everything that's required to use the library in the docs itself. 10 | 11 | * The unit tests written should be easy to understand and should read like an English sentence. 12 | 13 | * The library should not have any dependency with another dotnet library or framework. 14 | 15 | # Install 16 | 17 | To install the library, run the following command: 18 | ```bash 19 | $ dotnet add package Das.Test 20 | ``` 21 | 22 | # Docs 23 | 24 | * To use the library, use `open` statement: 25 | ```fsharp 26 | open Das.Test 27 | ``` 28 | 29 | * To understand how tests are written, let us look at how to test whether two numbers are equal: 30 | 31 | ```fsharp 32 | let num = 4 33 | 34 | verify 35 | "num is equal to 4" 36 | (val' num |> is equalTo (val' 4) 37 | ``` 38 | 39 | * `Das.Test` provides a function called `verify` which takes verification description as the first argument and the second argument as the test you want to perform. 40 | 41 | * At the most granular level, tests are written in the following format: 42 | ```fsharp 43 | val' num |> is equalTo (val' 4) 44 | ``` 45 | 46 | * The first argument, here `val' num` is the actual result, while as the second argument (`val' 4`) is the expected result. 47 | 48 | * `val'` is what I call **test type functions**, which are essentially functions which convert values into an internally defined test type. This conversion is required as the test functions operate on the test types. 49 | 50 | * This approach allows in reusing same function for multiple tests involving different data types. For instance, `contain` test can be used with both `string` and `list` types: 51 | 52 | ```fsharp 53 | (list' [1; 2; 3] |> does contain (val' 2)) 54 | 55 | (val' "some text" |> does contain (val' "ext")) 56 | ``` 57 | 58 | * Following test type functions are available: 59 | * `val'` to convert primitive types like `int`, `float` and `string`. 60 | * `list'` to convert lists. 61 | * `seq'` to convert sequences 62 | * `array'` to convert arrays 63 | * `map'` to convert maps 64 | * `option'` to convert `option` type 65 | 66 | * If you were to test something like `"num is not equal to 50"`, then you could write the test like: 67 | ```fsharp 68 | verify 69 | "num is not equal to 4" 70 | ((val' num) |> isNot equalTo (val' 50)) 71 | ``` 72 | 73 | * Notice `isNot` function. These are what I call **glue functions** which helps making test sound like proper English sentence. 74 | 75 | * Moreover, they alter the output of functions like `equalTo`. For instance, `is` would allow the default behavior of `equalTo`, while as `isNot` would invert its behavior, i.e. `equalTo` would then check whether the expected and actual results are not the same. 76 | 77 | * There are other similar glue functions like `has`, `does` and `doesNotHave`. 78 | 79 | * Sometimes, the expected value is not required (like when you just want to check whether a string is empty). In such a case, you would use `__` in place of expected value. For example, if you want to check whether string `name` is empty: 80 | 81 | ```fsharp 82 | (val' name |> is empty __) 83 | ``` 84 | 85 | * Other test examples: 86 | 87 | ```fsharp 88 | (val' 3.2 |> isNot lessThan (val' 3.19) 89 | 90 | (list' [1; 2; 3] |> has length (val' 3) 91 | 92 | type Point = { 93 | x: int 94 | y: int 95 | } 96 | 97 | type Point with 98 | static member squareDistance point = 99 | (point.x * point.x) + (point.y * point.y) 100 | static member op_GreaterThan (pointA: Point, pointB: Point) = 101 | (pointA |> Point.squareDistance) > (pointB |> Point.squareDistance) 102 | 103 | let pointA = { 104 | x = 1 105 | y = 1 106 | } 107 | 108 | let pointB = { 109 | x = 2 110 | y = 2 111 | } 112 | 113 | (val' pointA |> is lessThan (val' pointB) 114 | ``` 115 | 116 | For more examples, checkout `test` folder. 117 | 118 | * To write unit tests, use `unitTest` function which accepts unit test description as first argument and a lambda returning list of `verify` function results as second argument: 119 | 120 | ```fsharp 121 | unitTest 122 | "Test an integer is equal to another integer" 123 | (fun () -> 124 | let num = 4 125 | 126 | [ 127 | verify 128 | "3 is equal to 3" 129 | (val' 3 |> is equalTo (val' 3)) 130 | 131 | verify 132 | "3 is not equal to 4" 133 | (val' 3 |> isNot equalTo (val' 4)) 134 | 135 | verify 136 | "num is equal to 4" 137 | (val' num |> is equalTo (val' 4)) 138 | ] 139 | ) 140 | ``` 141 | 142 | * `unitTest`s can further be grouped into test suites via `testSuite` function which are expected to be one per file: 143 | 144 | ```fsharp 145 | testSuite 146 | "NumberTests.IntegerTestSuite.fs" 147 | [ 148 | unitTest 149 | "Test an integer is equal to another integer" 150 | (fun () -> 151 | let num = 4 152 | 153 | [ 154 | verify 155 | "3 is equal to 3" 156 | (val' 3 |> is equalTo (val' 3)) 157 | 158 | verify 159 | "3 is not equal to 4" 160 | (val' 3 |> isNot equalTo (val' 4)) 161 | 162 | verify 163 | "num is equal to 4" 164 | (val' num |> is equalTo (val' 4)) 165 | ] 166 | ) 167 | 168 | unitTest 169 | "Test an integer is greater than another integer" 170 | (fun () -> 171 | [ 172 | verify 173 | "3 is greater than 2" 174 | (val' 3 |> is greaterThan (val' 2)) 175 | 176 | verify 177 | "3 is not greater than than 4" 178 | (val' 3 |> isNot greaterThan (val' 4)) 179 | ] 180 | ) 181 | ] 182 | ``` 183 | 184 | * This function accepts test suite description as first argument and list of `unitTest` function results as second argument. 185 | 186 | * This function would return test execution details if all tests successful, or fail with details on unit test failing. 187 | 188 | * The tests are run in sequential order (as that's how I wanted), but if someone wants random order then let me know. 189 | 190 | # License 191 | 192 | AGPL v3 License, Copyright (c) 2022 Sumeet Das 193 | -------------------------------------------------------------------------------- /src/Library.fs: -------------------------------------------------------------------------------- 1 | namespace Das.Test 2 | 3 | [] 4 | module Core = 5 | (* 6 | Active patterns 7 | *) 8 | 9 | /// Active pattern for matching boolean values 10 | let (|IsBool|_|) x = 11 | match box x with 12 | | :? bool as x -> Some x 13 | | _ -> None 14 | 15 | /// Active pattern for matching integers 16 | let (|IsInt|_|) x = 17 | match box x with 18 | | :? int as x -> Some x 19 | | _ -> None 20 | 21 | let (|IsInt64|_|) x = 22 | match box x with 23 | | :? System.Int64 as x -> Some x 24 | | _ -> None 25 | 26 | /// Active pattern for matching floats 27 | let (|IsFloat|_|) x = 28 | match box x with 29 | | :? float as x -> Some x 30 | | _ -> None 31 | 32 | /// Active pattern for matching strings 33 | let (|IsString|_|) x = 34 | match box x with 35 | | :? string as x -> Some x 36 | | _ -> None 37 | 38 | type TestType<'a, 'k, 'v when 'k : comparison> = 39 | | TestSequence of 'a seq 40 | | TestArray of 'a array 41 | | TestList of 'a list 42 | | TestValue of 'a 43 | | TestOption of 'a option 44 | | TestMapKey of 'k 45 | | TestMapValue of 'v 46 | | TestMap of Map<'k , 'v> 47 | | TestNone 48 | 49 | let private xor a b = if a then not b else b 50 | let private isOrNot is = if is then "is" else "is not" 51 | let private doesOrNot is = if is then "does" else "does not" 52 | let private notSupported actual expected = 53 | sprintf "%A and/or %A are not supported" actual expected 54 | let formatString (str:string): string = 55 | if str.Contains "\n" && (str.Trim().Length <> 0) 56 | then sprintf "\"\"\"\n%s\n\"\"\"\n" str 57 | else sprintf "\"%s\"" str 58 | 59 | let val' (input: 'a) = TestValue input 60 | let value' (input: 'a) = val' input 61 | let list' (input: 'a list) = TestList input 62 | let array' (input: 'a array) = TestArray input 63 | let seq' (input: 'a seq) = TestSequence input 64 | let map' (input: Map<'a, 'b>) = TestMap input 65 | let key' (input: 'a) = TestMapKey input 66 | let __ = TestNone 67 | let none' = TestOption (None) 68 | let some' (input: 'a) = TestOption (Some input) 69 | 70 | let is func y x = func false y x 71 | let isNot func y x = func true y x 72 | let has func y x = func false y x 73 | let have func y x = func false y x 74 | let does func y x = func false y x 75 | let doesNot func y x = func true y x 76 | let doesNotHave func y x = func true y x 77 | 78 | let greaterThan (negate: bool) y x : Result = 79 | let is = negate 80 | let testGreaterThan x y = 81 | let resultOk = xor (x > y) negate 82 | if resultOk then Ok (true) 83 | else 84 | Error (sprintf "%A %s greater than %A" 85 | x (isOrNot is) y) 86 | 87 | match x, y with 88 | | TestValue x, TestValue y -> testGreaterThan x y 89 | | _ -> Error (notSupported x y) 90 | 91 | let greaterThanOrEqualTo (negate: bool) y x : Result = 92 | let is = negate 93 | let testGreaterThanOrEqualTo x y = 94 | let resultOk = xor (x >= y) negate 95 | if resultOk then Ok (true) 96 | else 97 | Error (sprintf "%A %s greater than or equal to %A" 98 | x (isOrNot is) y) 99 | 100 | match x, y with 101 | | TestValue x, TestValue y -> testGreaterThanOrEqualTo x y 102 | | _ -> Error (notSupported x y) 103 | 104 | let lessThan (negate: bool) y x : Result = 105 | let is = negate 106 | let testLessThan x y = 107 | let resultOk = xor (x < y) negate 108 | if resultOk then Ok (true) 109 | else 110 | Error (sprintf "%A %s less than %A" 111 | x (isOrNot is) y) 112 | 113 | match x, y with 114 | | TestValue x, TestValue y -> testLessThan x y 115 | | _ -> Error (notSupported x y) 116 | 117 | let lessThanOrEqualTo (negate: bool) y x 118 | : Result = 119 | 120 | let testLessThanOrEqualTo x y = 121 | let is = negate 122 | let resultOk = xor (x <= y) negate 123 | if resultOk then Ok (true) 124 | else 125 | Error (sprintf "%A %s less than or equal to %A" 126 | x (isOrNot is) y) 127 | 128 | match x, y with 129 | | TestValue x, TestValue y -> testLessThanOrEqualTo x y 130 | | _ -> Error (notSupported x y) 131 | 132 | let True (negate: bool) _ x 133 | : Result = 134 | 135 | match x with 136 | | TestValue tval -> 137 | match tval with 138 | | IsBool boolInput -> 139 | let resultOk = xor (boolInput = true) negate 140 | if resultOk then Ok (true) 141 | else 142 | let is = negate 143 | let text = 144 | sprintf "%b %s is not true" boolInput (isOrNot is) 145 | Error (text) 146 | | _ -> Error (notSupported x x) 147 | | _ -> Error (notSupported x x) 148 | 149 | let False (negate: bool) _ x 150 | : Result = 151 | 152 | match x with 153 | | TestValue tval -> 154 | match tval with 155 | | IsBool boolInput -> 156 | let resultOk = xor (boolInput = false) negate 157 | if resultOk then Ok (true) 158 | else 159 | let is = negate 160 | let text = 161 | sprintf "%b %s is not false" boolInput (isOrNot is) 162 | Error (text) 163 | | _ -> Error (notSupported x x) 164 | | _ -> Error (notSupported x x) 165 | 166 | let startWith (negate: bool) text x 167 | : Result = 168 | 169 | match x, text with 170 | | TestValue xVal, TestValue textVal -> 171 | match xVal, textVal with 172 | | IsString strX, IsString strText -> 173 | let resultOk = xor (strX.StartsWith(strText)) negate 174 | if resultOk then Ok (true) 175 | else 176 | let does = negate 177 | let message = sprintf "\"%s\" %s starts with \"%s\"" 178 | strX (doesOrNot does) strText 179 | Error (message) 180 | | _ -> Error (notSupported x text) 181 | | _ -> Error (notSupported x text) 182 | 183 | let endWith (negate: bool) text x 184 | : Result = 185 | 186 | match x, text with 187 | | TestValue xVal, TestValue textVal -> 188 | match xVal, textVal with 189 | | IsString strX, IsString strText -> 190 | let resultOk = xor (strX.EndsWith(strText)) negate 191 | if resultOk then Ok (true) 192 | else 193 | let does = negate 194 | let message = sprintf "\"%s\" %s ends with \"%s\"" 195 | strX (doesOrNot does) strText 196 | Error (message) 197 | | _ -> Error (notSupported x text) 198 | | _ -> Error (notSupported x text) 199 | 200 | let contain (negate: bool) y input 201 | : Result = 202 | 203 | match input, y with 204 | | TestValue inputVal, TestValue yVal -> 205 | match inputVal, yVal with 206 | | IsString strInput, IsString strY -> 207 | let resultOk = xor (strInput.Contains(strY)) negate 208 | if resultOk then Ok (true) 209 | else 210 | let does = negate 211 | let text = sprintf "\"%s\" %s contain string \"%s\"" 212 | strInput (doesOrNot does) strY 213 | Error (text) 214 | | _ -> Error (sprintf "Input %A is not supported." input) 215 | | _ -> 216 | Error (sprintf "Input %A is not supported." input) 217 | 218 | let equalTo (negate: bool) expected actual 219 | : Result = 220 | 221 | let testEqual a b = 222 | let resultOk = (xor (a = b) negate) 223 | if resultOk then Ok (true) 224 | else 225 | Error (sprintf "%A %s equal to %A" 226 | actual (isOrNot negate) expected) 227 | 228 | match actual, expected with 229 | | TestValue actual, TestValue expected -> testEqual actual expected 230 | | TestList actual, TestList expected -> testEqual actual expected 231 | | _ -> Error (notSupported actual expected) 232 | 233 | let empty (negate: bool) (_) x : Result = 234 | match x with 235 | | TestValue x -> 236 | match box x with 237 | | IsString str -> 238 | let resultOk = xor (str.Length = 0) negate 239 | if resultOk then Ok (true) 240 | else 241 | let is = negate 242 | let text = sprintf "%s %s an empty string" 243 | str (isOrNot is) 244 | Error (text) 245 | | _ -> Error (notSupported x x) 246 | | TestList list -> 247 | let resultOk = xor (list.Length = 0) negate 248 | 249 | if resultOk then Ok (true) 250 | else 251 | let is = negate 252 | let text = sprintf "%A %s an empty list" 253 | list (isOrNot is) 254 | Error (text) 255 | | _ -> 256 | Error (sprintf "Input %A is not supported" x) 257 | 258 | let length (negate: bool) (len: int) x : Result = 259 | match x with 260 | | TestValue tval -> 261 | match tval with 262 | | IsString str -> 263 | let resultOk = xor (str.Length = len) negate 264 | if resultOk then Ok (true) 265 | else 266 | let is = negate 267 | let text = sprintf "The length of %A %s %d" 268 | x (isOrNot is) len 269 | Error (text) 270 | | _ -> Error (notSupported x x) 271 | | TestList list -> 272 | let resultOk = xor (list.Length = len) negate 273 | if resultOk then Ok (true) 274 | else 275 | let is = negate 276 | let text = sprintf "The length of %A %s %d" 277 | list (isOrNot is) len 278 | Error (text) 279 | | _ -> 280 | Error (notSupported x len) 281 | 282 | let containsElem (negate: bool) elem collection : Result = 283 | 284 | match collection, elem with 285 | | TestList list, item -> 286 | let resultOk = xor (list |> List.contains item) negate 287 | if resultOk then Ok (true) 288 | else 289 | let does = negate 290 | let text = sprintf "List %A %s contain not element %A" 291 | list (doesOrNot does) elem 292 | Error (text) 293 | | _ -> 294 | Error (notSupported collection elem) 295 | 296 | let verify 297 | (testName: string) 298 | (testResult: Result) 299 | : Result = 300 | 301 | match testResult with 302 | | Ok (_) -> Ok (true) 303 | | Error (message) -> 304 | let text = 305 | sprintf "\n>> Verify `%s` failed. Reason:\n%s" 306 | testName message 307 | Error(text) 308 | 309 | let unitTest 310 | (testName: string) 311 | (testFunc: unit -> Result list) 312 | : Result = 313 | 314 | let verifyResults = testFunc() 315 | 316 | verifyResults 317 | |> List.map (fun result -> 318 | match result with 319 | | Ok (_) -> Ok (true) 320 | | Error (message) -> 321 | let text = 322 | sprintf 323 | "\n> Unit Test `%s` failed because of the following error:\n%s" 324 | testName message 325 | Error (text) 326 | ) 327 | |> List.filter (fun result -> 328 | match result with 329 | | Error (_) -> true 330 | | _ -> false) 331 | |> (fun list -> if list.Length = 0 then [ Ok (true) ] else list) 332 | |> List.head 333 | 334 | let testSuite 335 | (suiteName: string) 336 | (unitTestResults: Result list) 337 | : string = 338 | 339 | let totalUnitTests = unitTestResults.Length 340 | 341 | let numFailedUnitTests, failedUnitTestResults = 342 | unitTestResults 343 | |> List.fold 344 | (fun state result -> 345 | match result with 346 | | Ok (_) -> state 347 | | Error (message) -> 348 | let accCount, accMessage = state 349 | let updatedAccMessage = 350 | accMessage + "\n" + message 351 | (accCount + 1, updatedAccMessage) 352 | ) 353 | (0, "") 354 | 355 | let header = 356 | sprintf "%d/%d unit tests passed in test suite `%s`." 357 | (totalUnitTests - numFailedUnitTests) 358 | totalUnitTests 359 | suiteName 360 | 361 | if numFailedUnitTests = 0 then header 362 | else 363 | let failedTestDetails = 364 | sprintf "Failed unit tests: %s" failedUnitTestResults 365 | failwith ("\n" + header + "\n" + failedTestDetails) 366 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------