sdkver.go

/*
Package sdk is the gRPC implementation of the SDK gRPC server
Copyright 2018 Portworx

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// This file is used to read the SDK version generated from api.proto
// and update any other files with that information
package main

import (
	"encoding/json"
	"flag"
	"fmt"
	"io/ioutil"
	"os"

	"github.com/libopenstorage/openstorage/api"
	// Needed because of https://github.com/golang/mock/tree/v1.6.0#reflect-vendoring-error
	_ "github.com/golang/mock/mockgen/model"
)

type optionTypes struct {
	swaggerFile string
	checkMajor  string
	checkMinor  string
	checkPatch  string
}

var (
	options optionTypes
)

func init() {
	flag.StringVar(&options.swaggerFile, "swagger", "", "api.swagger.json file")
	flag.StringVar(&options.checkMajor, "check-major", "", "SDK Version.Major must match this value")
	flag.StringVar(&options.checkMinor, "check-minor", "", "SDK Version.Minor must match this value")
	flag.StringVar(&options.checkPatch, "check-patch", "", "SDK Version.Patch must match this value")
	flag.Parse()
}

func main() {

	// Set version
	version := fmt.Sprintf("%d.%d.%d",
		api.SdkVersion_Major,
		api.SdkVersion_Minor,
		api.SdkVersion_Patch)

	// Check major
	if !checkVersionValue("Major", options.checkMajor, fmt.Sprintf("%d", api.SdkVersion_Major)) ||
		!checkVersionValue("Minor", options.checkMinor, fmt.Sprintf("%d", api.SdkVersion_Minor)) ||
		!checkVersionValue("Patch", options.checkPatch, fmt.Sprintf("%d", api.SdkVersion_Patch)) {
		os.Exit(1)
	}

	// Set swagger file
	if len(options.swaggerFile) != 0 {
		if err := setSwaggerVersion(options.swaggerFile, version); err != nil {
			fmt.Printf("Error: %v\n", err)
			os.Exit(1)
		}
	}

	fmt.Printf("%s\n", version)
}

func setSwaggerVersion(file, version string) error {

	swaggerFile, err := ioutil.ReadFile(file)
	if err != nil {
		return err
	}

	jsonFile := make(map[string]interface{})
	err = json.Unmarshal(swaggerFile, &jsonFile)
	if err != nil {
		return err
	}

	// Set SDK information
	jsonFile["info"].(map[string]interface{})["title"] = "OpenStorage SDK"
	jsonFile["info"].(map[string]interface{})["version"] = version

	// Set support for bearer tokens
	type securitySchemes struct {
		BearerAuth struct {
			Type         string `json:"type"`
			Scheme       string `json:"scheme"`
			BearerFormat string `json:"bearerFormat"`
		} `json:"bearerAuth"`
	}
	schemes := securitySchemes{}
	schemes.BearerAuth.Type = "http"
	schemes.BearerAuth.Scheme = "bearer"
	schemes.BearerAuth.BearerFormat = "JWT"
	jsonFile["components"].(map[string]interface{})["securitySchemes"] = schemes

	// Set default security for all
	type securityDefault struct {
		BearerAuth []string `json:"bearerAuth"`
	}
	jsonFile["security"] = []securityDefault{
		securityDefault{
			BearerAuth: []string{},
		},
	}

	bytes, err := json.MarshalIndent(jsonFile, "", "  ")
	if err != nil {
		return err
	}

	err = ioutil.WriteFile(file, bytes, 0644)
	if err != nil {
		return err
	}

	return nil
}

func checkVersionValue(name, expected, actual string) bool {
	if len(expected) != 0 {
		if expected != actual {
			fmt.Printf("Error: SDK Version %s number expected to be %s does not match %s\n",
				name,
				expected,
				actual)
			return false
		}
	}

	return true
}