• Miek Gieben's avatar
    documention: test README snippets (#1043) · 6e3eec1e
    Miek Gieben authored
    If a README has a corefile snippet that is annotated with `corefile`,
    this test will parse the instance and checks the snippet is legal.
    This means a) we will get better docs b) we know for sure everything
    still parses.
    
    The test parses everything in middleware/*/README.md, it does not check
    for README presence, just Corefile snippets. The port used is 10053 and
    overrides whatever port is set in the docs.
    
    The secondary middleware was used as an example and adds two examples
    that should parse.
    
    failures show up as:
    
    ~~~
    --- FAIL: TestReadme (0.04s)
    	readme_test.go:50: Testing ../middleware/secondary/README.md, with 100 byte snippet
    	readme_test.go:50: Testing ../middleware/secondary/README.md, with 93 byte snippet
    	readme_test.go:53: Failed to start server for input "middleware/secondary: Corefile:3 - Error during parsing: unknown property 'transfeT'":
    		. {
    		    secondary example.net {
    		        transfeT from 10.1.2.1
    		        transfer to *
    		    }
    		}
    FAIL
    ~~~
    6e3eec1e
README.md 1.42 KB