service config version [T1031]

.circleci/check_configs.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+function compare_configs() {
+    folder_a=$1
+    folder_b=$2
+    binaries=(server connector translator addzone webconfig rollback keymaker poisonrecordmaker authmanager rotate)
+    for cmd in "${binaries[@]}"; do
+     cmp ${folder_a}/acra-${cmd}.yaml ${folder_b}/acra-${cmd}.yaml
+     cmp_status="$?"
+     if [[ "${cmp_status}" != "0" ]]; then
+        status=1
+     fi
+    done
+}
+# use go from GOROOT instead installed in system
+PATH=$GOROOT/bin:$PATH
+temp_configs=`mktemp -d`
+bash configs/regenerate.sh ${temp_configs}
+
+status=0
+compare_configs configs ${temp_configs}
+
+rm -rf ${temp_configs}
+exit ${status}

.circleci/config.yml

@@ -1,5 +1,33 @@
 version: 2
 jobs:
+  general_validation:
+    docker:
+      - image: cossacklabs/android-build
+    environment:
+      FILEPATH_ERROR_FLAG: /tmp/test_fail
+      VERSIONS: 1.11.5 1.12
+      TEST_DB_PORT: 5432
+      GOPATH_FOLDER: gopath
+      TEST_RANDOM_DATA_FOLDER: /tmp/test_data
+      TEST_TLS: "on"
+      # $HOME/$GOPATH_FOLDER
+      GOPATH: /home/user/gopath
+      # set default goroot instead system available
+      GOROOT: /home/user/go_root_1.11.5/go
+    steps:
+      # prepare
+      - checkout
+      - run: .circleci/prepare.sh
+      # validation
+      - run: .circleci/check_gofmt.sh
+      - run: .circleci/check_configs.sh | tee /home/user/tests_output
+      - run: .circleci/check_golint.sh
+      - run: .circleci/check_gotest.sh
+      # check python wrapper
+      - run: PYTHONPATH=`pwd`/wrappers/python python3 wrappers/python/acrawriter/tests.py
+      - store_artifacts:
+          path: /home/user/tests_output
+
   postgresql-ssl:
     docker:
       - image: cossacklabs/android-build
@@ -10,27 +38,22 @@ jobs:
           POSTGRES_DB: test
     environment:
       FILEPATH_ERROR_FLAG: /tmp/test_fail
-      VERSIONS: 1.10.8 1.11.5 1.12
+      VERSIONS: 1.11.5 1.12
       TEST_DB_PORT: 5432
       GOPATH_FOLDER: gopath
       TEST_RANDOM_DATA_FOLDER: /tmp/test_data
       TEST_TLS: "on"
+      # $HOME/$GOPATH_FOLDER
+      GOPATH: /home/user/gopath
+      # set default goroot instead system available
+      GOROOT: /home/user/go_root_1.11.5/go
     steps:
     # prepare
       - checkout
       - run: .circleci/prepare.sh
       - run: sudo apt-get install -y postgresql-client
       - run: pg_isready -U${POSTGRES_USER} -d${POSTGRES_DB} -h127.0.0.1
-    # testing
-      # check that code formatted with gofmt
-      - run: .circleci/check_gofmt.sh
-      # check that code doesn't have a lot of golint issues (currently removed because golint version is very different on other planforms)
-      - run: GOPATH=$HOME/$GOPATH_FOLDER .circleci/check_golint.sh
-      # delete file if exists
-      - run: if [ -f $FILEPATH_ERROR_FLAG ]; then rm "$FILEPATH_ERROR_FLAG"; fi
-      - run: .circleci/check_gotest.sh
-      # check python wrapper
-      - run: PYTHONPATH=`pwd`/wrappers/python python3 wrappers/python/acrawriter/tests.py
+      # testing
       # generate test data for integration tests
       - run: python3 tests/generate_random_data.py
       # each iteration pass to test different ports for forks to avoid problems with TCP TIME WAIT between tests
@@ -51,11 +74,15 @@ jobs:
           POSTGRES_DB: test
     environment:
       FILEPATH_ERROR_FLAG: /tmp/test_fail
-      VERSIONS: 1.10.8 1.11.5 1.12
+      VERSIONS: 1.11.5 1.12
       TEST_DB_PORT: 5432
       GOPATH_FOLDER: gopath
       TEST_RANDOM_DATA_FOLDER: /tmp/test_data
       TEST_TLS: "off"
+      # $HOME/$GOPATH_FOLDER
+      GOPATH: /home/user/gopath
+      # set default goroot instead system available
+      GOROOT: /home/user/go_root_1.11.5/go
     steps:
       # prepare
       - checkout
@@ -85,26 +112,23 @@ jobs:
         MYSQL_ROOT_PASSWORD: root
     environment:
       FILEPATH_ERROR_FLAG: /tmp/test_fail
-      VERSIONS: 1.10.8 1.11.5 1.12
+      VERSIONS: 1.11.5 1.12
       TEST_MYSQL: true
       TEST_DB_PORT: 3306
       GOPATH_FOLDER: gopath
       TEST_RANDOM_DATA_FOLDER: /tmp/test_data
       TEST_TLS: "on"
+      # $HOME/$GOPATH_FOLDER
+      GOPATH: /home/user/gopath
+      # set default goroot instead system available
+      GOROOT: /home/user/go_root_1.11.5/go
     steps:
     # prepare
     - checkout
     - run: .circleci/prepare.sh
     - run: sudo apt-get install -y mysql-client
     - run: mysqladmin ping -h127.0.0.1
     # testing
-    # check that code formatted with gofmt
-    - run: .circleci/check_gofmt.sh
-    # check that code doesn't have a lot of golint issues (currently removed because golint version is very different on other planforms)
-    - run: GOPATH=$HOME/$GOPATH_FOLDER .circleci/check_golint.sh
-    # delete file if exists
-    - run: if [ -f $FILEPATH_ERROR_FLAG ]; then rm "$FILEPATH_ERROR_FLAG"; fi
-    - run: .circleci/check_gotest.sh
     # generate test data for integration tests
     - run: python3 tests/generate_random_data.py
     # each iteration pass to test different ports for forks to avoid problems with TCP TIME WAIT between tests
@@ -128,12 +152,16 @@ jobs:
           MYSQL_ROOT_PASSWORD: root
     environment:
       FILEPATH_ERROR_FLAG: /tmp/test_fail
-      VERSIONS: 1.10.8 1.11.5 1.12
+      VERSIONS: 1.11.5 1.12
       TEST_MYSQL: true
       TEST_DB_PORT: 3306
       GOPATH_FOLDER: gopath
       TEST_RANDOM_DATA_FOLDER: /tmp/test_data
       TEST_TLS: "off"
+      # $HOME/$GOPATH_FOLDER
+      GOPATH: /home/user/gopath
+      # set default goroot instead system available
+      GOROOT: /home/user/go_root_1.11.5/go
     steps:
       # prepare
       - checkout
@@ -164,26 +192,23 @@ jobs:
         MYSQL_ROOT_PASSWORD: root
     environment:
       FILEPATH_ERROR_FLAG: /tmp/test_fail
-      VERSIONS: 1.10.8 1.11.5 1.12
+      VERSIONS: 1.11.5 1.12
       TEST_MYSQL: true
       TEST_DB_PORT: 3306
       GOPATH_FOLDER: gopath
       TEST_RANDOM_DATA_FOLDER: /tmp/test_data
       TEST_TLS: "on"
+      # $HOME/$GOPATH_FOLDER
+      GOPATH: /home/user/gopath
+      # set default goroot instead system available
+      GOROOT: /home/user/go_root_1.11.5/go
     steps:
     # prepare
     - checkout
     - run: .circleci/prepare.sh
     - run: sudo apt-get install -y mysql-client
     - run: mysqladmin ping -h127.0.0.1
     # testing
-    # check that code formatted with gofmt
-    - run: .circleci/check_gofmt.sh
-    # check that code doesn't have a lot of golint issues (currently removed because golint version is very different on other planforms)
-    - run: GOPATH=$HOME/$GOPATH_FOLDER .circleci/check_golint.sh
-    # delete file if exists
-    - run: if [ -f $FILEPATH_ERROR_FLAG ]; then rm "$FILEPATH_ERROR_FLAG"; fi
-    - run: .circleci/check_gotest.sh
     # generate test data for integration tests
     - run: python3 tests/generate_random_data.py
     # each iteration pass to test different ports for forks to avoid problems with TCP TIME WAIT between tests
@@ -205,12 +230,16 @@ jobs:
           MYSQL_ROOT_PASSWORD: root
     environment:
       FILEPATH_ERROR_FLAG: /tmp/test_fail
-      VERSIONS: 1.10.8 1.11.5 1.12
+      VERSIONS: 1.11.5 1.12
       TEST_MYSQL: true
       TEST_DB_PORT: 3306
       GOPATH_FOLDER: gopath
       TEST_RANDOM_DATA_FOLDER: /tmp/test_data
       TEST_TLS: "off"
+      # $HOME/$GOPATH_FOLDER
+      GOPATH: /home/user/gopath
+      # set default goroot instead system available
+      GOROOT: /home/user/go_root_1.11.5/go
     steps:
       # prepare
       - checkout
@@ -232,6 +261,7 @@ workflows:
   version: 2
   tests:
     jobs:
+      - general_validation
       - postgresql
       - postgresql-ssl
       - mysql

.circleci/integration.sh

@@ -39,7 +39,6 @@ for version in $VERSIONS; do
         timeout ${TEST_RUN_TIMEOUT} python3 tests/test.py -v | tee "${LOG_OUTPUT}";
         status="$?"
         if [[ "${status}" != "0" ]]; then
-            status="$?"
             echo "${context}. status=${status}" >> "$FILEPATH_ERROR_FLAG";
             continue
         else

cmd/acra-addzone/acra-addzone.go

@@ -57,7 +57,8 @@ func main() {
 
 	err := cmd.Parse(defaultConfigPath, serviceName)
 	if err != nil {
-		log.WithError(err).Errorln("Can't parse args")
+		log.WithError(err).WithField(logging.FieldKeyEventCode, logging.EventCodeErrorCantReadServiceConfig).
+			Errorln("Can't parse args")
 		os.Exit(1)
 	}
 	//LoadFromConfig(defaultConfigPath)

cmd/acra-authmanager/acra_authmanager.go

@@ -179,7 +179,8 @@ func main() {
 	debug := flag.Bool("d", false, "Turn on debug logging")
 
 	if err := cmd.Parse(defaultConfigPath, serviceName); err != nil {
-		log.WithError(err).Errorln("Can't parse cmd arguments")
+		log.WithError(err).WithField(logging.FieldKeyEventCode, logging.EventCodeErrorCantReadServiceConfig).
+			Errorln("Can't parse cmd args")
 		os.Exit(1)
 	}
 

cmd/acra-keymaker/acra-keymaker.go

@@ -55,7 +55,8 @@ func main() {
 
 	err := cmd.Parse(defaultConfigPath, serviceName)
 	if err != nil {
-		log.WithError(err).Errorln("Can't parse args")
+		log.WithError(err).WithField(logging.FieldKeyEventCode, logging.EventCodeErrorCantReadServiceConfig).
+			Errorln("Can't parse args")
 		os.Exit(1)
 	}
 

cmd/acra-poisonrecordmaker/acra-poisonrecordmaker.go

@@ -53,7 +53,8 @@ func main() {
 
 	err := cmd.Parse(defaultConfigPath, serviceName)
 	if err != nil {
-		log.WithError(err).Errorln("can't parse args")
+		log.WithError(err).WithField(logging.FieldKeyEventCode, logging.EventCodeErrorCantReadServiceConfig).
+			Errorln("can't parse args")
 		os.Exit(1)
 	}
 

cmd/acra-rollback/acra-rollback.go

@@ -171,7 +171,8 @@ func main() {
 
 	err := cmd.Parse(defaultConfigPath, serviceName)
 	if err != nil {
-		log.WithError(err).Errorln("Can't parse args")
+		log.WithError(err).WithField(logging.FieldKeyEventCode, logging.EventCodeErrorCantReadServiceConfig).
+			Errorln("Can't parse args")
 		os.Exit(1)
 	}
 

cmd/acra-rotate/acra-rotate.go

@@ -78,7 +78,8 @@ func main() {
 
 	err := cmd.Parse(DefaultConfigPath, ServiceName)
 	if err != nil {
-		log.WithError(err).Errorln("Can't parse args")
+		log.WithError(err).WithField(logging.FieldKeyEventCode, logging.EventCodeErrorCantReadServiceConfig).
+			Errorln("Can't parse args")
 		os.Exit(1)
 	}
 

cmd/acra-server/acra-server.go

@@ -164,7 +164,7 @@ func main() {
 		log.WithField(logging.FieldKeyEventCode, logging.EventCodeErrorWrongConfiguration).
 			Errorln("db_host is empty: you must specify db_host")
 		flag.Usage()
-		return
+		os.Exit(1)
 	}
 	config.setDBConnectionSettings(*dbHost, *dbPort)
 

cmd/utils.go

@@ -18,6 +18,7 @@ limitations under the License.
 package cmd
 
 import (
+	"errors"
 	flag_ "flag"
 	"fmt"
 	"github.com/cossacklabs/acra/logging"
@@ -175,6 +176,10 @@ func PrintDefaults() {
 
 // GenerateYaml generates YAML file from CLI params
 func GenerateYaml(output io.Writer, useDefault bool) {
+	// write version as first line in yaml format
+	if _, err := fmt.Fprintf(output, "version: %s\n", utils.VERSION); err != nil {
+		panic(err)
+	}
 	flag_.CommandLine.VisitAll(func(flag *flag_.Flag) {
 		var s string
 		if useDefault {
@@ -245,6 +250,35 @@ func DumpConfig(configPath, serviceName string, useDefault bool) error {
 	return nil
 }
 
+func checkVersion(config map[string]interface{}) error {
+	if config == nil {
+		return nil
+	}
+	configVersion, ok := config["version"]
+	if !ok {
+		return errors.New("config hasn't version key")
+	}
+	versionValue, ok := configVersion.(string)
+	if !ok {
+		return errors.New("value of version is not string")
+	}
+
+	version, err := utils.ParseVersion(versionValue)
+	if err != nil {
+		return err
+	}
+
+	serverVersion, err := utils.GetParsedVersion()
+	if err != nil {
+		return err
+	}
+
+	if serverVersion.CompareOnly(utils.MajorFlag|utils.MinorFlag, version) != utils.Equal {
+		return fmt.Errorf("config version \"%s\" is not supported, expects \"%s\" version", version.String(), serverVersion.String())
+	}
+	return nil
+}
+
 // Parse loads CLI params from yaml config and cli
 func Parse(configPath, serviceName string) error {
 	/*load from yaml config and cli. if dumpconfig option pass than generate config and exit*/
@@ -258,6 +292,7 @@ func Parse(configPath, serviceName string) error {
 	if *config != "" {
 		configPath = *config
 	}
+	var yamlConfig map[string]interface{}
 	var args []string
 	// parse yaml and add params that wasn't passed from cli
 	if configPath != "" {
@@ -275,7 +310,6 @@ func Parse(configPath, serviceName string) error {
 			if err != nil {
 				return err
 			}
-			yamlConfig := map[string]interface{}{}
 			err = yaml.Unmarshal([]byte(data), &yamlConfig)
 			if err != nil {
 				return err
@@ -307,6 +341,9 @@ func Parse(configPath, serviceName string) error {
 		DumpConfig(configPath, serviceName, true)
 		os.Exit(0)
 	}
+	if err = checkVersion(yamlConfig); err != nil {
+		return err
+	}
 	return nil
 }
 

configs/acra-addzone.yaml

@@ -1,3 +1,4 @@
+version: 0.84.2
 # path to config
 config_file: 
 

configs/acra-authmanager.yaml

@@ -1,3 +1,4 @@
+version: 0.84.2
 # path to config
 config_file: 
 

configs/acra-connector.yaml

@@ -1,3 +1,4 @@
+version: 0.84.2
 # Port of Acra HTTP API
 acraserver_api_connection_port: 9090
 

configs/acra-keymaker.yaml

@@ -1,3 +1,4 @@
+version: 0.84.2
 # Client ID
 client_id: client