Use the new "Go Modules" as package manager for go (#62)

* Use the new "Go Modules" as package manager for go packages. Also update README.MD with updated build instructions.

* Updated after review

.dockerfiles/Dockerfile

@@ -5,19 +5,25 @@ COPY sources-18.04-azure.list /etc/apt/sources.list
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
     build-essential \
+    curl \
     patchelf \
     git \
     python3-setuptools \
     python3-wheel \
     python3-pip \
-    golang-go \
-    go-dep \
     && rm -rf /var/lib/apt/lists/*
 
-# Install packr
-ENV GOPATH=/go
-ENV PATH=${GOPATH}/bin:${PATH}
-RUN go get -v -u github.com/gobuffalo/packr/packr
+# Install Go
+RUN curl "https://dl.google.com/go/go1.11.5.linux-amd64.tar.gz" | tar xvz -C /usr/local; \
+    export PATH="/usr/local/go/bin:$PATH"; \
+    go version
 
-# Install  Conan package manager
-RUN pip3 install conan
+ENV GOPATH /go
+ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
+
+RUN mkdir -p "$GOPATH/src" "$GOPATH/bin" && chmod -R 777 "$GOPATH"
+WORKDIR $GOPATH
+
+# Install additional build tools
+RUN go get -v -u github.com/gobuffalo/packr/packr && go clean -cache
+RUN pip3 install conan cmake

.gitignore

@@ -17,9 +17,8 @@ cse-server-go
 .idea
 
 # Client build directory and artifact
-resources/public/js/compiled/app.js
+resources/public/
 
-# Dep/packr
-Gopkg.lock
-resources/
-vendor/
+# Conan output
+include/
+dist/

Jenkinsfile

@@ -16,44 +16,37 @@ pipeline {
                     agent { label 'windows' }
 
                     environment {
-                        GOPATH = "${WORKSPACE}"
-                        GOBIN = "${WORKSPACE}/bin"
-                        PATH = "${env.MINGW_HOME}/bin;${GOBIN};${env.PATH}"
-                        CGO_CFLAGS = "-I${WORKSPACE}/src/cse-server-go/include"
-                        CGO_LDFLAGS = "-L${WORKSPACE}/src/cse-server-go/dist/bin -lcsecorec"
+                        GOPATH = "${env.BASE}/gopath/${env.EXECUTOR_NUMBER}"
+                        PATH = "${env.MINGW_HOME}/bin;${GOPATH}/bin;${env.PATH}"
                         CONAN_USER_HOME = "${env.BASE}/conan-repositories/${env.EXECUTOR_NUMBER}"
                         CONAN_USER_HOME_SHORT = "${env.CONAN_USER_HOME}"
                         OSP_CONAN_CREDS = credentials('jenkins-osp-conan-creds')
                     }
 
                     tools {
-                        go 'go-1.11'
+                        go 'go-1.11.5'
                         //'com.cloudbees.jenkins.plugins.customtools.CustomTool' 'mingw-w64' awaiting fix in customToolsPlugin
                     }
 
                     stages {
                         stage ('Get dependencies') {
                             steps {
-                                dir ("${GOBIN}") {
-                                    sh 'curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh'
-                                }
                                 copyArtifacts(
                                     projectName: 'open-simulation-platform/cse-client/master',
                                     filter: 'resources/public/**/*',
                                     target: 'src/cse-server-go')
 
                                 dir ('src/cse-server-go') {
-                                    sh 'go get github.com/gobuffalo/packr/packr'
                                     sh 'conan remote add osp https://osp-conan.azurewebsites.net/artifactory/api/conan/conan-local --force'
                                     sh 'conan user -p $OSP_CONAN_CREDS_PSW -r osp $OSP_CONAN_CREDS_USR'
                                     sh 'conan install . -s build_type=Release'
-                                    sh 'dep ensure'
                                 }
                             }
                         }
                         stage ('Packr') {
                             steps {
                                 dir ('src/cse-server-go') {
+                                    sh 'go get -v github.com/gobuffalo/packr/packr'
                                     sh 'go clean -cache'
                                     sh 'packr build -v'
                                 }
@@ -113,9 +106,8 @@ pipeline {
                     }
 
                     environment {
-                        GOPATH = "${WORKSPACE}"
-                        CGO_CFLAGS = "-I${WORKSPACE}/src/cse-server-go/include" 
-                        CGO_LDFLAGS = "-L${WORKSPACE}/src/cse-server-go/dist/lib -lcsecorec -Wl,-rpath,\$ORIGIN/../lib"
+                        GOCACHE = "/tmp/.gocache"
+                        CGO_LDFLAGS = "-Wl,-rpath,\$ORIGIN/../lib"
                         CONAN_USER_HOME = '/conan_repo'
                         CONAN_USER_HOME_SHORT = 'None'
                         OSP_CONAN_CREDS = credentials('jenkins-osp-conan-creds')
@@ -134,7 +126,6 @@ pipeline {
                                     sh 'conan user -p $OSP_CONAN_CREDS_PSW -r osp $OSP_CONAN_CREDS_USR'
                                     sh 'conan install . -s build_type=Release -s compiler.libcxx=libstdc++11'
                                     sh 'patchelf --set-rpath \'$ORIGIN/../lib\' dist/lib/*'
-                                    sh 'dep ensure'
                                 }
                             }
                         }

README.md

@@ -1,66 +1,88 @@
-# cse-server-go
-playground for testing go as an alternative for the cse-server
+CSE demo application in Go
+==========================
 
-# Get going (windows)
-- install [go](https://golang.org/dl/)
-- environmental variables must be defined
-    - [GOROOT](https://golang.org/doc/install#tarball_non_standard) - directory where go is installed
-    - [GOPATH](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable) - where to look for Go files
-- install [MinGW-w64](https://sourceforge.net/projects/mingw-w64/?source=typ_redirect) (TODO: Should investigate using VS)
-- csecorec.dll and csecorecpp.dll must be manually copied into cse-server-go root folder
-- go build will compile executable
+ This repository contains demo application for CSE written in Go
 
-# Dependencies
-- Install the dep tool https://golang.github.io/dep/
-- Type `dep ensure` in your shell to download deps to your disk.
-- Install packr:`go get -u github.com/gobuffalo/packr/...`
 
-# Interactive web development (client)
-- Install https://leiningen.org/ (and possibly a Java JDK)
-- cd /client
-- lein figwheel
+How to build
+------------
 
-# Interactive web development (server)
-- Install https://github.com/codegangsta/gin
-- Did not get any further on this, but should be the way to go.
+### Required tools
+  * Go dev tools: [Golang](https://golang.org/dl/) >= 1.11
+  * Compiler: [MinGW-w64](https://sourceforge.net/projects/mingw-w64/?source=typ_redirect) (Windows), GCC >= 7 (Linux)
+  * Package managers: [Conan](https://conan.io/) and [Go Modules](https://github.com/golang/go/wiki/Modules)
 
-# Building binary distribution
-- In client folder: Run `lein cljsbuild once min`
-- In server root folder: Run `packr build`
+Throughout this guide, we will use Conan to manage C++ dependencies. However, you can also install the C++ dependencies manually.
 
-# Build and run on Ubuntu
+### Step 1: Configure Conan
 
-Tested on Ubuntu 16.04, but will most likely work on Ubuntu 18.04 and other Linux distributions as well.
+First, add the OSP Conan repository as a remote and configure the username and
+password to access it:
 
-Download archive and install [Go](https://golang.org/doc/install#install) (Tested with 1.11.2)  
+    conan remote add osp https://osp-conan.azurewebsites.net/artifactory/api/conan/conan-local
+    conan user -p "Open Simulation Platform" -r osp osp
 
-Add \<install path\>/bin to PATH variable in /etc/environment.
+### Step 2: Cse Client
 
-In case you want to change the default Go workspace path (\<home path\>/go) you can set it with GOPATH in `/etc/environment`.
+If you want to include the cse-client in the server you will have to manually copy in the client app. Latest build of 
+the client is available here: https://osp-jenkins.azurewebsites.net/job/open-simulation-platform/job/cse-client/job/master/lastSuccessfulBuild/artifact/
 
-And to be able to run installed Go packages like e.g. packr without providing the full path, you might also want to add \<workspace path\>/bin to PATH variable in /etc/environment.
+Extract the files into:
+
+    ./resources/public
+
+Alternatively you can run the client using figwheel as described in https://github.com/open-simulation-platform/cse-client
 
-https://help.ubuntu.com/community/EnvironmentVariables#A.2Fetc.2Fenvironment  
-_Note: Variable expansion does not work in this file, and you have to log out and in again to apply changes._
+### Step 3: Build and run
 
-Clone this repository to \<workspace path\>/src
+You can do this in two ways:
 
-Change directory to \<workspace path\>/src/cse-server-go  
-Download all imported packages  
-`go get -d -v ./...`
+#### Alternative 1: Using Conan
 
-The next step is to pull and build the latest version of cse-core and then tell Go where to look for cse-core headers and shared libraries.
-That can be done with the environment variables `CGO_CFLAGS` and `CGO_LDFLAGS`, and you can either add them permanently to e.g. `/etc/environment`, ~/.profile or just set them on the command line before calling go build, like shown below.
+From the cse-server-go source directory, get C/C++ dependencies using Conan:
 
-```
-CGO_CFLAGS="-I\<cse-core path\>/include" CGO_LDFLAGS="-L\<cse-core path\>/build/output/release/lib -lcsecorec -Wl,-rpath=\<cse-core path\>/build/output/release/lib" go build
-```
+    conan install . -s build_type=Release -g virtualrunenv
+    go build
 
-_Note: It also sets the rpath (runtime search path) so that you don't have to provide it via e.g. `LD_LIBRARY_PATH` when you run it._
+To run the application on Windows:
+
+    activate_run.bat
+    cse-server-go.exe
+    deactivate_run.bat when done
+
+To run the application on Linux:
 
-Run it  
-```
-./cse-server-go
-```
+    source activate_run.sh
+    ./cse-server-go
+    ./deactivate_run.sh when done
+
+Open a browser at http://localhost:8000/status to verify that it's running (you should see some JSON).
 
-And then open a browser at e.g. http://localhost:8000/status to verify that it's running (you should see some JSON).
+#### Alternative 2: Manually handle cse-core dependencies
+
+You will have to define CGO environment variables with arguments pointing to your cse-core headers and libraries. An 
+example for Windows can be:
+
+    set CGO_CFLAGS=-IC:\dev\cse-core\include
+    set CGO_LDFLAGS=-LC:\dev\cse-core\bin -lcsecorec -lcsecorecpp
+    go build
+
+To run the application on Windows you need to also update the path to point to your libraries:
+
+    set PATH=C:\cse-core\bin;%PATH%
+    cse-server-go.exe
+
+To run the application on Linux you need to update the LD_LIBRARY_PATH:
+
+    LD_LIBRARY_PATH=~dev/cse-core/lib:$LD_LIBRARY_PATH
+    export LD_LIBRARY_PATH
+    ./cse-server-go
+
+Open a browser at http://localhost:8000/status to verify that it's running (you should see some JSON).
+
+### Create distribution with built-in client
+
+To package the application with the client you can use packr. You can install packr and build distributable with:
+
+    go get -u github.com/gobuffalo/packr/packr
+    packr build

conanfile.txt

@@ -1,5 +1,4 @@
 [generators]
-virtualbuildenv
 
 [requires]
 cse-core/0.1.0@osp/master

cse/cse.go

@@ -1,6 +1,8 @@
 package cse
 
 /*
+	#cgo CFLAGS: -I${SRCDIR}/../include
+	#cgo LDFLAGS: -L${SRCDIR}/../dist/bin -L${SRCDIR}/../dist/lib -lcsecorec -lstdc++
 	#include <cse.h>
 */
 import "C"
@@ -430,7 +432,6 @@ func initializeSimulation(sim *Simulation, fmuDir string, logDir string) (bool,
 		executionAddObserver(execution, fileObserver)
 	}
 
-
 	manipulator := createOverrideManipulator()
 	executionAddManipulator(execution, manipulator)
 

go.mod

@@ -0,0 +1,8 @@
+module cse-server-go
+
+require (
+	github.com/gobuffalo/packr v1.22.0
+	github.com/gorilla/mux v1.7.0
+	github.com/gorilla/websocket v1.4.0
+	golang.org/x/net v0.0.0-20190213061140-3a22650c66bd
+)