better logging & fix ARMmbed#1

davidhyman · davidhyman · commit 2df5a34ed6e1 · 2018-03-28T19:07:55.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -105,3 +105,6 @@ ENV/
 
 # editors
 *.idea
+
+# test directory
+tmp_test_dir
diff --git a/src/snippet/config.py b/src/snippet/config.py
@@ -7,7 +7,7 @@
 class Config:
     # IO
     input_glob = 'tests/example/*.py'
-    output_template = '```python\n# example: {{{name}}}\n{{{code}}}\n```'  # a mustache template for each file
+    output_template = '```python\n# example: {{{name}}}\n{{{code}}}\n```\n'  # a mustache template for each file
     output_append = False  # if the output file exists, append to it
     output_dir = None
     output_file_ext = 'md'
diff --git a/src/snippet/snippet.py b/src/snippet/snippet.py
@@ -25,44 +25,46 @@ def extract_snippets(config: Config, lines, path):
             capture = True
             continue
 
+        current_debug_key = f'{current_key} ({line_num})'
+
         if config.end_flag in line:
             # stop capturing, and discard empty blocks
             if not capture:
-                raise exceptions.StartEndMismatch(f'Not yet capturing at {current_key}')
+                raise exceptions.StartEndMismatch(f'Not yet capturing at {current_debug_key}')
             capture = False
             if not current_block:
                 examples.pop(current_key)
             continue
 
         if config.uncloak_flag in line:
             if not cloak:
-                raise exceptions.CloakMismatch(f'Already uncloaked at {current_key}')
+                raise exceptions.CloakMismatch(f'Already uncloaked at {current_debug_key}')
             cloak = False
             continue
 
         if capture and not cloak:
             if config.cloak_flag in line:
                 if cloak:
-                    raise exceptions.CloakMismatch(f'Already cloaked at {current_key}')
+                    raise exceptions.CloakMismatch(f'Already cloaked at {current_debug_key}')
                 cloak = True
                 continue
 
             # whilst capturing, append code lines to the current block
-            if config.fail_on_dedent and any(line[:current_strip].split(' ')):
-                raise exceptions.ValidationFailure(f'Unexpected dedent whilst capturing {current_key}')
+            if config.fail_on_dedent and any(line[:current_strip].lstrip()):
+                raise exceptions.ValidationFailure(f'Unexpected dedent whilst capturing {current_debug_key}')
             clean_line = line[current_strip:].rstrip()
             for r_before, r_after in config.replacements.items():
                 clean_line = clean_line.replace(r_before, r_after)
             for trigger in config.fail_on_contains:
                 if trigger in clean_line:
-                    raise exceptions.ValidationFailure(f'Unexpected phrase {repr(trigger)} at {current_key}')
+                    raise exceptions.ValidationFailure(f'Unexpected phrase {repr(trigger)} at {current_debug_key}')
             # add this line of code to the example block
             current_block.append(clean_line)
 
     if capture:
-        raise exceptions.StartEndMismatch(f'EOF reached whilst still capturing {current_key}')
+        raise exceptions.StartEndMismatch(f'EOF reached whilst still capturing {current_debug_key}')
 
     if cloak:
-        raise exceptions.CloakMismatch(f'EOF reached whilst still cloaked {current_key}')
+        raise exceptions.CloakMismatch(f'EOF reached whilst still cloaked {current_debug_key}')
 
     return examples
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1,3 @@
+import os
+tmp_test_dirname = 'tmp_test_dir'
+tmp_test_dir = os.path.join(os.path.dirname(os.path.dirname(__file__)), tmp_test_dirname)
diff --git a/tests/samples/example.java b/tests/samples/example.java
@@ -0,0 +1,40 @@
+import static org.junit.Assert.fail;
+
+import java.util.Arrays;
+
+import io.reactivex.BackpressureStrategy;
+
+
+public class Banana extends Fruit {
+
+    /**
+     * Foos a Bar.
+     * <p>
+     * Note: This example introduces new high level abstraction objects
+     */
+
+    @Example
+    public void fooABar() {
+        Wibble wibbler = new Wobble(config);
+        try {
+            // an example: number 1
+            // For more information about backpressure strategies, please have a look at related documentation:
+            // https://github.com/ReactiveX/RxJava/wiki/Backpressure
+            wibbler.subscribe(
+                    Thing1.newFilter().likeDevice("016%")
+                            .inDeviceStates(Arrays.asList(DeviceState.A, DeviceState.B)),
+                    BackpressureStrategy.BUFFER).flow().subscribe(System.out::println);
+
+            // Listening to device state changes for 2 minutes.
+            Thread.sleep(120000);
+
+            // Stopping the Wobble.
+            wibbler.stop();
+            // end of example
+
+        } catch (Exception e) {
+            e.printStackTrace();
+            fail(e.getMessage());
+        }
+    }
+}
diff --git a/tests/samples/example.py b/tests/samples/example.py
@@ -0,0 +1,16 @@
+# this is a python module
+
+
+class A:
+    """A class"""
+    def my_example(self):
+        # an example: number 1
+        print('x: 5')
+        for number in range(5):
+            print(number)
+        # end of example
+
+
+class B:
+    # something unrelated
+    pass
diff --git a/tests/samples/fixture.md b/tests/samples/fixture.md
@@ -0,0 +1,21 @@
+```python
+# example: number 1
+print('x: 5')
+for number in range(5):
+    print(number)
+```
+```java
+# example: number 1
+// For more information about backpressure strategies, please have a look at related documentation:
+// https://github.com/ReactiveX/RxJava/wiki/Backpressure
+wibbler.subscribe(
+        Thing1.newFilter().likeDevice("016%")
+                .inDeviceStates(Arrays.asList(DeviceState.A, DeviceState.B)),
+        BackpressureStrategy.BUFFER).flow().subscribe(System.out::println);
+
+// Listening to device state changes for 2 minutes.
+Thread.sleep(120000);
+
+// Stopping the Wobble.
+wibbler.stop();
+```
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -7,9 +7,11 @@
 
 import snippet
 
+from tests import tmp_test_dir
+
 
 class Test(unittest.TestCase):
-    tmpdir = os.path.join(os.path.dirname(os.path.dirname(__file__)), 'tmp_test_dir')
+    tmpdir = tmp_test_dir
 
     @classmethod
     def setUpClass(cls):
diff --git a/tests/test_direct.py b/tests/test_direct.py
@@ -0,0 +1,41 @@
+import unittest
+import snippet
+import os
+import shutil
+import filecmp
+
+from tests import tmp_test_dir
+
+
+class Test(unittest.TestCase):
+    sample_input = os.path.join(os.path.dirname(__file__), 'samples')
+    sample_output_dir = os.path.join(os.path.dirname(__file__), tmp_test_dir)
+
+    def setUp(self):
+        if os.path.exists(self.sample_output_dir):
+            shutil.rmtree(self.sample_output_dir)
+
+    def tearDown(self):
+        shutil.rmtree(self.sample_output_dir)
+
+    def test_run(self):
+        # writing two different languages sequentially to the same file
+
+        config = snippet.Config()
+        config.output_dir = self.sample_output_dir
+        config.output_append = True
+
+        # only detect the python file
+        config.input_glob = 'tests/samples/example.py'
+        snippet.main(config=config)
+
+        # only detect the java file
+        config.output_template = '```java\n# example: {{{name}}}\n{{{code}}}\n```'
+        config.input_glob = 'tests/samples/example.java'
+        snippet.main(config=config)
+
+        self.assertTrue(filecmp.cmp(
+            os.path.join(self.sample_output_dir, 'number1.md'),
+            os.path.join(self.sample_input, 'fixture.md'),
+            shallow=False,
+        ))
diff --git a/tests/test_parser.py b/tests/test_parser.py
@@ -44,14 +44,32 @@ def test_plain(self):
         self.go_exact(Config(), [start, 'test', newline, A, B, C, stop])
 
     def test_indent(self):
-        # left pad the sequence by two, to check result is dedented to depth of start
+        # left pad the sequence by two spaces, to check result is dedented to depth of start
         sequence = [f'  {x}' for x in [start + 'test' + newline, A, B, C]]
         sequence.append(stop)
         self.go_exact(
             Config(),
             sequence
         )
 
+    def test_indent_tabs(self):
+        # left pad the sequence by two tabs, to check result is dedented to depth of start
+        sequence = [f'\t\t{x}' for x in [start + 'test' + newline, A, B, C]]
+        sequence.append(stop)
+        self.go_exact(
+            Config(),
+            sequence
+        )
+
+    def test_indent_with_blank_line(self):
+        # left pad the sequence and then have some blank lines
+        sequence = [f'    {x}' for x in [start + 'test' + newline, A, B, C, stop]]
+        sequence.insert(2, '')
+        self.go_exact(
+            Config(),
+            sequence
+        )
+
     def test_trigger_phrase(self):
         with self.assertRaises(exceptions.ValidationFailure):
             self.go_exact(Config(), [start, 'test', newline, A, B, C, 'assert\n', stop])
diff --git a/tmp_test_dirs/config.toml b/tmp_test_dirs/config.toml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import os`
	`2`	`+tmp_test_dirname = 'tmp_test_dir'`
	`3`	`+tmp_test_dir = os.path.join(os.path.dirname(os.path.dirname(__file__)), tmp_test_dirname)`