Merge pull request #4 from MichaHoffmann/fix_compilation_errors_on_macos

add compile workflow

Author: MichaHoffmann

.github/workflows/build.yaml

@@ -0,0 +1,28 @@
+name: build
+
+on:
+  push:
+
+jobs:
+  compile:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        compiler: [gcc, clang++]
+
+    name: compile
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - if: matrix.os == 'windows-latest' && matrix.compiler == 'clang++'
+        uses: KyleMayes/install-llvm-action@v1
+        with:
+          version: "11.0"
+
+      - if: matrix.os == 'windows-latest' && matrix.compiler == 'gcc'
+        uses: egor-tensin/setup-mingw@v2
+
+      - name: build
+        run: ${{ matrix.compiler }} -o scanner.o -I./src -c src/scanner.cc

.gitignore

@@ -7,3 +7,8 @@ log.html
 tree-sitter-hcl.wasm
 .env
 .DS_Store
+
+fuzz/fuzzer
+fuzz/*.o
+fuzz/*.a
+fuzz/fuzz-*.log

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "fuzz/tree-sitter"]
+	path = fuzz/tree-sitter
+	url = https://github.com/tree-sitter/tree-sitter.git

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.3.2 - not yet released
+
+fix:
+* add a build step to CI to make sure the scanner is compilable
+
 ## 0.3.1 - 2021-06-30
 
 fix:

README.md

@@ -28,7 +28,7 @@ Total parses: 1892; successful parses: 1892; failed parses: 0; success percentag
 
 ## Fuzzing
 
-The directory `fuzz/crashers` contains a set of crashes that were found with fuzzing. To fuzz the parser i used the instrumentation of [tree-sitter](https://github.com/tree-sitter/tree-sitter/tree/master/test/fuzz) 
+The directory `fuzz/crashers` contains a set of crashes that were found with fuzzing.
 
 ## Todo
 
@@ -39,8 +39,8 @@ The directory `fuzz/crashers` contains a set of crashes that were found with fuz
   * [x] add heredoc templates
 * [ ] fuzzing
   * [x] start with fuzzing the parser
-  * [ ] upload fuzzing instrumentation
+  * [x] upload fuzzing instrumentation
   * [ ] document fuzzing process
 * [ ] quality
-  * [ ] add CI job that ensures the parser builds on different plattforms
+  * [x] add CI job that ensures the parser builds on different plattforms
   * [ ] add CI job that parses crashers that were found during fuzzing

example/example.hcl

@@ -33,6 +33,11 @@ resource_1 "strlit1" "strlit2" {
     ${func("foo${ var.bar }")}
     suffix
   EOF
+  func_of_object = func({
+    "foo": 2,
+    bar: 1,
+    fizz: buzz,
+  })
 
   nested_resource_1 {
     attr1 = 2

fuzz/Makefile

@@ -0,0 +1,30 @@
+FUZZFLAGS=-fsanitize=fuzzer,address,undefined
+
+JOBS=4
+WORKERS=4
+
+.PHONY: fuzz
+fuzz: fuzzer hcl.dict
+	UBSAN="print_stacktrace=1:halt_on_error=1:symbolize=1"  ASAN_OPTIONS="quarantine_size_mb=10:detect_leaks=1:symbolize=1" ./fuzzer -jobs=${JOBS} -workers=${WORKERS} -dict=hcl.dict corpus/
+
+.PHONY: clean
+clean:
+	rm -rf tree-sitter
+	rm fuzzer parser.o scanner.o libtree-sitter.a
+
+fuzzer: parser.o scanner.o libtree-sitter.a
+	clang++ -o fuzzer ${FUZZFLAGS} -std=c++11 tree-sitter/test/fuzz/fuzzer.cc -Itree-sitter/lib scanner.o parser.o libtree-sitter.a
+
+scanner.o: ../src/scanner.cc
+	clang++ -o scanner.o ${FUZZFLAGS} -std=c++11 -I../src -c ../src/scanner.cc
+
+parser.o: ../src/parser.c
+	clang -o parser.o ${FUZZFLAGS} -std=c99 -I../src -c ../src/parser.c
+
+hcl.dict:
+	tree-sitter/scripts
+
+libtree-sitter.a:
+	make -C tree-sitter
+	cp tree-sitter/libtree-sitter.a .
+