newt/newtutil/newtutil.go - mynewt-artifact - Git at Google

 /**
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.
  */

 package newtutil

 import (
 	"fmt"
 	"io/ioutil"
 	"os/user"
 	"sort"
 	"strconv"
 	"strings"

 	log "github.com/Sirupsen/logrus"
 	"github.com/spf13/cast"

 	"mynewt.apache.org/newt/newt/interfaces"
 	"mynewt.apache.org/newt/util"
 	"mynewt.apache.org/newt/viper"
 )

 var NewtVersion Version = Version{1, 3, 0}
 var NewtVersionStr string = "Apache Newt version: 1.3.0"
 var NewtBlinkyTag string = "mynewt_1_3_0_tag"
 var NewtNumJobs int
 var NewtForce bool

 const NEWTRC_DIR string = ".newt"
 const REPOS_FILENAME string = "repos.yml"

 const CORE_REPO_NAME string = "apache-mynewt-core"
 const ARDUINO_ZERO_REPO_NAME string = "mynewt_arduino_zero"

 type Version struct {
 	Major    int64
 	Minor    int64
 	Revision int64
 }

 func ParseVersion(s string) (Version, error) {
 	v := Version{}
 	parseErr := util.FmtNewtError("Invalid version string: %s", s)

 	parts := strings.Split(s, ".")
 	if len(parts) != 3 {
 		return v, parseErr
 	}

 	var err error

 	v.Major, err = strconv.ParseInt(parts[0], 10, 64)
 	if err != nil {
 		return v, parseErr
 	}

 	v.Minor, err = strconv.ParseInt(parts[1], 10, 64)
 	if err != nil {
 		return v, parseErr
 	}

 	v.Revision, err = strconv.ParseInt(parts[2], 10, 64)
 	if err != nil {
 		return v, parseErr
 	}

 	return v, nil
 }

 func (v *Version) String() string {
 	return fmt.Sprintf("%d.%d.%d", v.Major, v.Minor, v.Revision)
 }

 func VerCmp(v1 Version, v2 Version) int64 {
 	if r := v1.Major - v2.Major; r != 0 {
 		return r
 	}

 	if r := v1.Minor - v2.Minor; r != 0 {
 		return r
 	}

 	if r := v1.Revision - v2.Revision; r != 0 {
 		return r
 	}

 	return 0
 }

 // Contains general newt settings read from $HOME/.newt
 var newtrc *viper.Viper

 func readNewtrc() *viper.Viper {
 	usr, err := user.Current()
 	if err != nil {
 		return viper.New()
 	}

 	dir := usr.HomeDir + "/" + NEWTRC_DIR
 	v, err := util.ReadConfig(dir, strings.TrimSuffix(REPOS_FILENAME, ".yml"))
 	if err != nil {
 		log.Debugf("Failed to read %s/%s file", dir, REPOS_FILENAME)
 		return viper.New()
 	}

 	return v
 }

 func Newtrc() *viper.Viper {
 	if newtrc != nil {
 		return newtrc
 	}

 	newtrc = readNewtrc()
 	return newtrc
 }

 func GetSliceFeatures(v *viper.Viper, features map[string]bool,
 	key string) []interface{} {

 	val := v.Get(key)
 	vals := []interface{}{val}

 	// Process the features in alphabetical order to ensure consistent
 	// results across repeated runs.
 	featureKeys := make([]string, 0, len(features))
 	for feature, _ := range features {
 		featureKeys = append(featureKeys, feature)
 	}
 	sort.Strings(featureKeys)

 	for _, feature := range featureKeys {
 		overwriteVal := v.Get(key + "." + feature + ".OVERWRITE")
 		if overwriteVal != nil {
 			return []interface{}{overwriteVal}
 		}

 		appendVal := v.Get(key + "." + feature)
 		if appendVal != nil {
 			vals = append(vals, appendVal)
 		}
 	}

 	return vals
 }

 func GetStringMapFeatures(v *viper.Viper, features map[string]bool,
 	key string) map[string]interface{} {

 	result := map[string]interface{}{}

 	slice := GetSliceFeatures(v, features, key)
 	for _, itf := range slice {
 		sub := cast.ToStringMap(itf)
 		for k, v := range sub {
 			result[k] = v
 		}
 	}

 	return result
 }

 func GetStringFeatures(v *viper.Viper, features map[string]bool,
 	key string) string {
 	val := v.GetString(key)

 	// Process the features in alphabetical order to ensure consistent
 	// results across repeated runs.
 	var featureKeys []string
 	for feature, _ := range features {
 		featureKeys = append(featureKeys, feature)
 	}
 	sort.Strings(featureKeys)

 	for _, feature := range featureKeys {
 		overwriteVal := v.GetString(key + "." + feature + ".OVERWRITE")
 		if overwriteVal != "" {
 			val = strings.Trim(overwriteVal, "\n")
 			break
 		}

 		appendVal := v.GetString(key + "." + feature)
 		if appendVal != "" {
 			val += " " + strings.Trim(appendVal, "\n")
 		}
 	}
 	return strings.TrimSpace(val)
 }

 func GetBoolFeaturesDflt(v *viper.Viper, features map[string]bool,
 	key string, dflt bool) (bool, error) {

 	s := GetStringFeatures(v, features, key)
 	if s == "" {
 		return dflt, nil
 	}

 	b, err := strconv.ParseBool(s)
 	if err != nil {
 		return dflt, util.FmtNewtError("invalid bool value for %s: %s",
 			key, s)
 	}

 	return b, nil
 }

 func GetBoolFeatures(v *viper.Viper, features map[string]bool,
 	key string) (bool, error) {

 	return GetBoolFeaturesDflt(v, features, key, false)
 }

 func GetStringSliceFeatures(v *viper.Viper, features map[string]bool,
 	key string) []string {

 	vals := GetSliceFeatures(v, features, key)

 	strVals := []string{}
 	for _, v := range vals {
 		subVals := cast.ToStringSlice(v)
 		strVals = append(strVals, subVals...)
 	}

 	return strVals
 }

 // Parses a string of the following form:
 //     [@repo]<path/to/package>
 //
 // @return string               repo name ("" if no repo)
 //         string               package name
 //         error                if invalid package string
 func ParsePackageString(pkgStr string) (string, string, error) {
 	// remove possible trailing '/'
 	pkgStr = strings.TrimSuffix(pkgStr, "/")

 	if strings.HasPrefix(pkgStr, "@") {
 		nameParts := strings.SplitN(pkgStr[1:], "/", 2)
 		if len(nameParts) == 1 {
 			return "", "", util.NewNewtError(fmt.Sprintf("Invalid package "+
 				"string; contains repo but no package name: %s", pkgStr))
 		} else {
 			return nameParts[0], nameParts[1], nil
 		}
 	} else {
 		return "", pkgStr, nil
 	}
 }

 func FindRepoDesignator(s string) (int, int) {
 	start := strings.Index(s, "@")
 	if start == -1 {
 		return -1, -1
 	}

 	len := strings.Index(s[start:], "/")
 	if len == -1 {
 		return -1, -1
 	}

 	return start, len
 }

 func ReplaceRepoDesignators(s string) (string, bool) {
 	start, len := FindRepoDesignator(s)
 	if start == -1 {
 		return s, false
 	}
 	repoName := s[start+1 : start+len]

 	proj := interfaces.GetProject()
 	repoPath := proj.FindRepoPath(repoName)
 	if repoPath == "" {
 		return s, false
 	}

 	// Trim common project base from repo path.
 	relRepoPath := strings.TrimPrefix(repoPath, proj.Path()+"/")

 	return s[:start] + relRepoPath + s[start+len:], true
 }

 func BuildPackageString(repoName string, pkgName string) string {
 	if repoName != "" {
 		return "@" + repoName + "/" + pkgName
 	} else {
 		return pkgName
 	}
 }

 func GeneratedPreamble() string {
 	return fmt.Sprintf("/**\n * This file was generated by %s\n */\n\n",
 		NewtVersionStr)
 }

 // Creates a temporary directory for downloading a repo.
 func MakeTempRepoDir() (string, error) {
 	tmpdir, err := ioutil.TempDir("", "newt-repo")
 	if err != nil {
 		return "", util.ChildNewtError(err)
 	}

 	return tmpdir, nil
 }
	/**
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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.
	*/

	package newtutil

	import (
	"fmt"
	"io/ioutil"
	"os/user"
	"sort"
	"strconv"
	"strings"

	log "github.com/Sirupsen/logrus"
	"github.com/spf13/cast"

	"mynewt.apache.org/newt/newt/interfaces"
	"mynewt.apache.org/newt/util"
	"mynewt.apache.org/newt/viper"
	)

	var NewtVersion Version = Version{1, 3, 0}
	var NewtVersionStr string = "Apache Newt version: 1.3.0"
	var NewtBlinkyTag string = "mynewt_1_3_0_tag"
	var NewtNumJobs int
	var NewtForce bool

	const NEWTRC_DIR string = ".newt"
	const REPOS_FILENAME string = "repos.yml"

	const CORE_REPO_NAME string = "apache-mynewt-core"
	const ARDUINO_ZERO_REPO_NAME string = "mynewt_arduino_zero"

	type Version struct {
	Major int64
	Minor int64
	Revision int64
	}

	func ParseVersion(s string) (Version, error) {
	v := Version{}
	parseErr := util.FmtNewtError("Invalid version string: %s", s)

	parts := strings.Split(s, ".")
	if len(parts) != 3 {
	return v, parseErr
	}

	var err error

	v.Major, err = strconv.ParseInt(parts[0], 10, 64)
	if err != nil {
	return v, parseErr
	}

	v.Minor, err = strconv.ParseInt(parts[1], 10, 64)
	if err != nil {
	return v, parseErr
	}

	v.Revision, err = strconv.ParseInt(parts[2], 10, 64)
	if err != nil {
	return v, parseErr
	}

	return v, nil
	}

	func (v *Version) String() string {
	return fmt.Sprintf("%d.%d.%d", v.Major, v.Minor, v.Revision)
	}

	func VerCmp(v1 Version, v2 Version) int64 {
	if r := v1.Major - v2.Major; r != 0 {
	return r
	}

	if r := v1.Minor - v2.Minor; r != 0 {
	return r
	}

	if r := v1.Revision - v2.Revision; r != 0 {
	return r
	}

	return 0
	}

	// Contains general newt settings read from $HOME/.newt
	var newtrc *viper.Viper

	func readNewtrc() *viper.Viper {
	usr, err := user.Current()
	if err != nil {
	return viper.New()
	}

	dir := usr.HomeDir + "/" + NEWTRC_DIR
	v, err := util.ReadConfig(dir, strings.TrimSuffix(REPOS_FILENAME, ".yml"))
	if err != nil {
	log.Debugf("Failed to read %s/%s file", dir, REPOS_FILENAME)
	return viper.New()
	}

	return v
	}

	func Newtrc() *viper.Viper {
	if newtrc != nil {
	return newtrc
	}

	newtrc = readNewtrc()
	return newtrc
	}

	func GetSliceFeatures(v *viper.Viper, features map[string]bool,
	key string) []interface{} {

	val := v.Get(key)
	vals := []interface{}{val}

	// Process the features in alphabetical order to ensure consistent
	// results across repeated runs.
	featureKeys := make([]string, 0, len(features))
	for feature, _ := range features {
	featureKeys = append(featureKeys, feature)
	}
	sort.Strings(featureKeys)

	for _, feature := range featureKeys {
	overwriteVal := v.Get(key + "." + feature + ".OVERWRITE")
	if overwriteVal != nil {
	return []interface{}{overwriteVal}
	}

	appendVal := v.Get(key + "." + feature)
	if appendVal != nil {
	vals = append(vals, appendVal)
	}
	}

	return vals
	}

	func GetStringMapFeatures(v *viper.Viper, features map[string]bool,
	key string) map[string]interface{} {

	result := map[string]interface{}{}

	slice := GetSliceFeatures(v, features, key)
	for _, itf := range slice {
	sub := cast.ToStringMap(itf)
	for k, v := range sub {
	result[k] = v
	}
	}

	return result
	}

	func GetStringFeatures(v *viper.Viper, features map[string]bool,
	key string) string {
	val := v.GetString(key)

	// Process the features in alphabetical order to ensure consistent
	// results across repeated runs.
	var featureKeys []string
	for feature, _ := range features {
	featureKeys = append(featureKeys, feature)
	}
	sort.Strings(featureKeys)

	for _, feature := range featureKeys {
	overwriteVal := v.GetString(key + "." + feature + ".OVERWRITE")
	if overwriteVal != "" {
	val = strings.Trim(overwriteVal, "\n")
	break
	}

	appendVal := v.GetString(key + "." + feature)
	if appendVal != "" {
	val += " " + strings.Trim(appendVal, "\n")
	}
	}
	return strings.TrimSpace(val)
	}

	func GetBoolFeaturesDflt(v *viper.Viper, features map[string]bool,
	key string, dflt bool) (bool, error) {

	s := GetStringFeatures(v, features, key)
	if s == "" {
	return dflt, nil
	}

	b, err := strconv.ParseBool(s)
	if err != nil {
	return dflt, util.FmtNewtError("invalid bool value for %s: %s",
	key, s)
	}

	return b, nil
	}

	func GetBoolFeatures(v *viper.Viper, features map[string]bool,
	key string) (bool, error) {

	return GetBoolFeaturesDflt(v, features, key, false)
	}

	func GetStringSliceFeatures(v *viper.Viper, features map[string]bool,
	key string) []string {

	vals := GetSliceFeatures(v, features, key)

	strVals := []string{}
	for _, v := range vals {
	subVals := cast.ToStringSlice(v)
	strVals = append(strVals, subVals...)
	}

	return strVals
	}

	// Parses a string of the following form:
	// [@repo]<path/to/package>
	//
	// @return string repo name ("" if no repo)
	// string package name
	// error if invalid package string
	func ParsePackageString(pkgStr string) (string, string, error) {
	// remove possible trailing '/'
	pkgStr = strings.TrimSuffix(pkgStr, "/")

	if strings.HasPrefix(pkgStr, "@") {
	nameParts := strings.SplitN(pkgStr[1:], "/", 2)
	if len(nameParts) == 1 {
	return "", "", util.NewNewtError(fmt.Sprintf("Invalid package "+
	"string; contains repo but no package name: %s", pkgStr))
	} else {
	return nameParts[0], nameParts[1], nil
	}
	} else {
	return "", pkgStr, nil
	}
	}

	func FindRepoDesignator(s string) (int, int) {
	start := strings.Index(s, "@")
	if start == -1 {
	return -1, -1
	}

	len := strings.Index(s[start:], "/")
	if len == -1 {
	return -1, -1
	}

	return start, len
	}

	func ReplaceRepoDesignators(s string) (string, bool) {
	start, len := FindRepoDesignator(s)
	if start == -1 {
	return s, false
	}
	repoName := s[start+1 : start+len]

	proj := interfaces.GetProject()
	repoPath := proj.FindRepoPath(repoName)
	if repoPath == "" {
	return s, false
	}

	// Trim common project base from repo path.
	relRepoPath := strings.TrimPrefix(repoPath, proj.Path()+"/")

	return s[:start] + relRepoPath + s[start+len:], true
	}

	func BuildPackageString(repoName string, pkgName string) string {
	if repoName != "" {
	return "@" + repoName + "/" + pkgName
	} else {
	return pkgName
	}
	}

	func GeneratedPreamble() string {
	return fmt.Sprintf("/*\n This file was generated by %s\n */\n\n",
	NewtVersionStr)
	}

	// Creates a temporary directory for downloading a repo.
	func MakeTempRepoDir() (string, error) {
	tmpdir, err := ioutil.TempDir("", "newt-repo")
	if err != nil {
	return "", util.ChildNewtError(err)
	}

	return tmpdir, nil
	}