Skip to content

README.md

Latest commit

 

History

History
116 lines (73 loc) · 3.24 KB

README.md

File metadata and controls

116 lines (73 loc) · 3.24 KB

sonar-go-to-slang

Generate slang serialized AST in JSON from a go source file.

Requirements

  • Docker (specifically, Docker Buildx)
  • (optional, required on Sonar machines) CA certificate for FortiClient traffic inspection in the project root directory

Building

Build in Docker environment

For convenience, the build automatically provisions a Docker container with pre-configured Go environment. The tasks are automatically linked to assemble, check, and build tasks, so you usually don't need to run them directly.

Build Docker image:

./gradlew :sonar-go-to-slang:buildDockerImage

Execute build inside Docker generating and building Go code and executing tests:

./gradlew :sonar-go-to-slang:dockerCompileGo

In case you system does not require the certificate for traffic inspection set -DtrafficInspection=false while running any Gradle task. Otherwise, place the .crt file into the project root directory.

What happens under the hood

The entire build process can be done with the make.sh script.

First, determine Go version used in the project:

export GO_VERSION=$(grep -E '^goVersion=' ../gradle.properties | cut -d'=' -f2)

The following command will download Go of the required version and build the project:

./make.sh build

Individual build steps are described below.

To generate goparser_generated.go file in current directory, run:

go generate

To create sonar-go-to-slang executable in current directory, run:

go build

To create sonar-go-to-slang executable in $GOPATH/bin, run:

go install

Building on Windows

When trying to build sonar-go-to-slang on Windows, the build may fail with the following error:

Create symbolic link at [...]\slang\sonar-go-to-slang.gogradle\project_gopath\src\github.com\SonarSource\slang\sonar-go-to-slang failed

Creating the symbolic link by hand solves this problem:

     mklink /D ".gogradle\project_gopath\src\github.com\SonarSource\slang\sonar-go-to-slang" "Absolute\Path\To\slang\sonar-go-to-slang"

Running

If you have $GOPATH/bin on your PATH, it's easy to run with slang-generator-go.

Run with -h or -help or --help to get usage help.

Print the SLANG Json tree for some source.go:

sonar-go-to-slang source.go

Dump the native raw AST for some source.go:

sonar-go-to-slang -d source.go

Testing

To perform the tests, run:

go test

To update expected test data, use the method fix_all_go_files_test_automatically in goparser_test.go.

Tips and tricks

Segmentation fault during Go build on MacOS Sequoia

In case you can't run it on MacOs Sequoia 15.3.1 and have the issues like: illegal instructions or reflect: /usr/local/go/pkg/tool/linux_amd64/asm: signal: segmentation fault try flipping the Rosetta option in Docker Settings. Disabling Use Rosetta for x86_64/amd64 emulation on Apple Silicon usually solve the problem. Src: https://www.reddit.com/r/golang/comments/1eoe3on/docker_illegal_instructions_and_apple_silicon/