Test output as comment (#335)

* feat(test): new solution for output, #332

* feat(test): new solution for output, #332

* Update src/tests/stdlib.rs

Co-authored-by: Phoenix Himself <pkaras.it@gmail.com>

* feat(review): variable

* feat(review): variable

* Update src/tests/stdlib.rs

Co-authored-by: Phoenix Himself <pkaras.it@gmail.com>

* feat(std): migrated the tests to comment

* feat(validity): migrating the tests to comment

* feat(validity): migrating the tests to comment

* feat(doc): updated

---------

Co-authored-by: Phoenix Himself <pkaras.it@gmail.com>

CONTRIBUTING.md

@@ -234,7 +234,13 @@ Amber uses `cargo test` for tests. `stdlib` and `validity` tests usually work by
 
 We have [`validity tests`](src/tests/validity.rs) to check if the compiler outputs a valid bash code, [`stdlib tests`](src/tests/stdlib.rs) and [`CLI tests`](src/tests/cli.rs).
 
-The majority of `stdlib` tests are Written in pure Amber in the folder [`tests/stdlib`](src/tests/stdlib). For every test there is a `*.output.txt` file that contains the expected output.
+The majority of `stdlib` tests are written in pure Amber in the folder [`tests/stdlib`](src/tests/stdlib). 
+For every test there are 3 ways to check the result following this order:
+
+* if a `// Output` comment on top that include the output to match
+* if there is a `*.output.txt` file that contains the expected output
+* "Succeded" will used as default value if the previous cases are not satisfied
+
 Tests will be executed without recompilation. Amber will load the scripts and verify the output in the designated file to determine if the test passes.
 The `validity` tests are full in Amber in their folder the folder [`tests/validity`](src/tests/validity).
 

src/tests/stdlib.rs

@@ -18,11 +18,32 @@ fn stdlib_test(input: &str) {
     let code =
         fs::read_to_string(input).unwrap_or_else(|_| panic!("Failed to open {input} test file"));
 
-    let output = match Path::new(&input.replace(".ab", ".output.txt")).exists() {
-        true => fs::read_to_string(input.replace(".ab", ".output.txt"))
-            .unwrap_or_else(|_| panic!("Failed to open {input}.output.txt file")),
-        _ => "Succeded".to_string(),
-    };
+    let mut is_output = false;
+    let mut output = "".to_owned();
+    for line in code.lines() {
+        if line.starts_with("// Output") {
+            is_output = true;
+            continue;
+        } else if line.is_empty() && is_output {
+            is_output = false;
+            break;
+        }
+
+        if is_output {
+            if ! output.is_empty() {
+                output.push_str("\n");
+            }
+            output.push_str(&line.replace("//", "").trim());
+        }
+    }
+
+    if output.is_empty() {
+        output = match Path::new(&input.replace(".ab", ".output.txt")).exists() {
+            true => fs::read_to_string(input.replace(".ab", ".output.txt"))
+                .expect(&format!("Failed to open {input}.output.txt file")),
+            _ => "Succeded".to_string()
+        };
+    }
 
     test_amber!(code, output);
 }

src/tests/stdlib/array_first_index.ab

@@ -1,4 +1,8 @@
 import * from "std/array"
+
+// Output
+// 2
+
 main {
     echo array_first_index([1, 2, 3, 4], 3)
 } 

src/tests/stdlib/array_search.ab

@@ -1,4 +1,8 @@
 import * from "std/array"
+
+// Output
+// 6
+
 main {
     let result = array_search([1, 2, 3, 4, 3], 3)
     echo result[0]+result[1]

src/tests/stdlib/chars.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// h e l l o
+
 main {
     echo chars("hello")
 } 

src/tests/stdlib/color_echo.ab

@@ -1,4 +1,8 @@
 import * from "std/env"
+
+// Output
+// Hello Amber!
+
 main {
     color_echo("Hello Amber!", 33)
 } 

src/tests/stdlib/contains.ab

@@ -1,6 +1,6 @@
 import { contains } from "std/text"
 main {
     if contains("Hello World", "World") {
-        echo "found"
+        echo "Succeded"
     }
 } 

src/tests/stdlib/echo_info.ab

@@ -1,4 +1,8 @@
 import * from "std/env"
+
+// Output
+//  Hello Amber! 
+
 main {
     echo_info("Hello Amber!")
 } 

src/tests/stdlib/echo_success.ab

@@ -1,4 +1,8 @@
 import * from "std/env"
+
+// Output
+//  Hello Amber! 
+
 main {
     echo_success("Hello Amber!")
 } 

src/tests/stdlib/echo_warning.ab

@@ -1,4 +1,8 @@
 import * from "std/env"
+
+// Output
+//  Hello Amber! 
+
 main {
     echo_warning("Hello Amber!")
 } 

src/tests/stdlib/error.ab

@@ -1,4 +1,8 @@
 import * from "std/env"
+
+// Output
+//  Hello Amber! 
+
 main {
     error("Hello Amber!", 0)
 } 

src/tests/stdlib/has_failed.ab

@@ -1,4 +1,8 @@
 import * from "std/env"
+
+// Output
+// Command failed
+
 main {
     if has_failed("ls /nonexistent") {
         echo "Command failed"

src/tests/stdlib/in_array.ab

@@ -1,4 +1,8 @@
 import * from "std/array"
+
+// Output
+// 1
+
 main {
     let result = in_array([1, 2, 3, 4, 3], 3)
     echo result

src/tests/stdlib/includes_empty_num_array.ab

@@ -1,5 +1,8 @@
 import * from "std/array"
 
+// Output
+// Not Found
+
 main {
     let array = [Num]
     if includes(array, 0) {

src/tests/stdlib/includes_empty_text_array.ab

@@ -1,5 +1,8 @@
 import * from "std/array"
 
+// Output
+// Not Found
+
 main {
     let array = [Text]
     if includes(array, " ") {

src/tests/stdlib/includes_partial_match_with_expanded_element.ab

@@ -1,5 +1,8 @@
 import * from "std/array"
 
+// Output
+// Not Found
+
 main {
     let array = ["foo", "bar", "baz"]
     if includes(array, "oo ba") {

src/tests/stdlib/includes_prefix_match.ab

@@ -1,5 +1,8 @@
 import * from "std/array"
 
+// Output
+// Not Found
+
 main {
     let array = ["apple", "banana cherry"]
     if includes(array, "banana") {

src/tests/stdlib/input.ab

@@ -1,4 +1,8 @@
 import * from "std/env"
+
+// Output
+// Please enter your name:Hello, Amber
+
 main {
     unsafe $echo "Amber" >> /tmp/test_input$
     unsafe $exec 0< /tmp/test_input$

src/tests/stdlib/join.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// apple,banana,cherry
+
 main {
     echo join(["apple", "banana", "cherry"], ", ")
 }

src/tests/stdlib/len_list.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// 4
+
 main {
     echo len([1, 2, 3, 4])
 } 

src/tests/stdlib/len_string.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// 5
+
 main {
     echo len("hello")
 } 

src/tests/stdlib/lines.ab

@@ -1,4 +1,9 @@
 import { lines } from "std/text"
+
+// Output
+// line: hello
+// line: world
+
 main {
     loop line in lines("hello\nworld") {
         echo "line: " + line

src/tests/stdlib/load_env_file.ab

@@ -1,5 +1,9 @@
 import { load_env_file, get_env_var } from "std/env"
 import { file_write } from "std/fs"
+
+// Output
+// yes
+
 main {
     let tmpdir = unsafe $mktemp -d /tmp/amber-XXXX$
     unsafe $cd {tmpdir}$

src/tests/stdlib/lower.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// hello world
+
 main {
     echo lower("HELLO WORLD")
 } 

src/tests/stdlib/make_executable.ab

@@ -1,4 +1,8 @@
 import { make_executable } from "std/fs"
+
+// Output
+// created
+
 main {
     let tmpdir = unsafe $mktemp -d /tmp/amber-XXXX$
     unsafe $touch {tmpdir}/amber-symbolic$

src/tests/stdlib/parse.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// 123
+
 main {
     echo parse("123")?
 } 

src/tests/stdlib/printf.ab

@@ -1,5 +1,8 @@
 import * from "std/env"
 
+// Output
+// Hello, Amber!
+
 main {
     printf("%s,%s!\n", ["Hello", " Amber"])
 } 

src/tests/stdlib/printf_escape.ab

@@ -1,5 +1,8 @@
 import * from "std/env"
 
+// Output
+// Hello \\v Amber %%T
+
 main {
     echo printf_escape("Hello \v Amber %T")
 } 

src/tests/stdlib/replace.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// apple apple
+
 main {
     echo replace("banana banana", "banana", "apple")
 }

src/tests/stdlib/replace_regex.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// abc456def
+
 main {
     echo replace_regex("abc123def", "[0-9][0-9]*", "456")
 }

src/tests/stdlib/split.ab

@@ -1,4 +1,8 @@
 import * from "std/text"
+
+// Output
+// banana
+
 main {
     let array = split("apple,banana,cherry", ",")
     echo array[1]