Merge pull request #2341 from chipaca/envbool

many: unify boolean env var handling

asserts/sysdb/trusted.go

@@ -21,9 +21,9 @@ package sysdb
 
 import (
 	"fmt"
-	"os"
 
 	"github.com/snapcore/snapd/asserts"
+	"github.com/snapcore/snapd/osutil"
 )
 
 const (
@@ -130,7 +130,7 @@ func init() {
 // Trusted returns a copy of the current set of trusted assertions as used by Open.
 func Trusted() []asserts.Assertion {
 	trusted := []asserts.Assertion(nil)
-	if os.Getenv("SNAPPY_USE_STAGING_STORE") != "1" {
+	if !osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
 		trusted = append(trusted, trustedAssertions...)
 	} else {
 		trusted = append(trusted, trustedStagingAssertions...)

cmd/cmd.go

@@ -55,7 +55,7 @@ func ExecInCoreSnap() {
 		return
 	}
 
-	if os.Getenv(key) != "1" {
+	if !osutil.GetenvBool(key) {
 		return
 	}
 

image/image.go

@@ -252,7 +252,7 @@ func bootstrapToRootDir(sto Store, model *asserts.Model, opts *Options, local *l
 	f := makeFetcher(sto, &DownloadOptions{}, db)
 
 	if err := f.Save(model); err != nil {
-		if os.Getenv("UBUNTU_IMAGE_SKIP_COPY_UNVERIFIED_MODEL") == "" {
+		if !osutil.GetenvBool("UBUNTU_IMAGE_SKIP_COPY_UNVERIFIED_MODEL") {
 			return fmt.Errorf("cannot fetch and check prerequisites for the model assertion: %v", err)
 		} else {
 			logger.Noticef("Cannot fetch and check prerequisites for the model assertion, it will not be copied into the image: %v", err)

logger/logger.go

@@ -27,6 +27,8 @@ import (
 	"log/syslog"
 	"os"
 	"sync"
+
+	"github.com/snapcore/snapd/osutil"
 )
 
 // A Logger is a fairly minimal logging tool.
@@ -109,7 +111,7 @@ func (l *ConsoleLog) Debug(msg string) {
 	s := "DEBUG: " + msg
 	l.sys.Output(3, s)
 
-	if os.Getenv("SNAPD_DEBUG") != "" {
+	if osutil.GetenvBool("SNAPD_DEBUG") {
 		l.log.Output(3, s)
 	}
 }

osutil/env.go

@@ -0,0 +1,41 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 2016 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+package osutil
+
+import (
+	"os"
+	"strconv"
+)
+
+// GetenvBool returns whether the given key may be considered "set" in the environment
+// (i.e. it is set to one of "1", "true", etc)
+func GetenvBool(key string) bool {
+	val := os.Getenv(key)
+	if val == "" {
+		return false
+	}
+
+	b, err := strconv.ParseBool(val)
+	if err != nil {
+		return false
+	}
+
+	return b
+}

osutil/env_test.go

@@ -0,0 +1,59 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 2016 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+package osutil_test
+
+import (
+	"os"
+
+	"gopkg.in/check.v1"
+
+	"github.com/snapcore/snapd/osutil"
+)
+
+type envSuite struct{}
+
+var _ = check.Suite(&envSuite{})
+
+func (s *envSuite) TestGetenvBoolTrue(c *check.C) {
+	key := "__XYZZY__"
+	os.Unsetenv(key)
+
+	for _, s := range []string{
+		"1", "t", "TRUE", // etc
+	} {
+		os.Setenv(key, s)
+		c.Assert(os.Getenv(key), check.Equals, s)
+		c.Check(osutil.GetenvBool(key), check.Equals, true, check.Commentf(s))
+	}
+}
+
+func (s *envSuite) TestGetenvBoolFalse(c *check.C) {
+	key := "__XYZZY__"
+	os.Unsetenv(key)
+	c.Assert(osutil.GetenvBool(key), check.Equals, false)
+
+	for _, s := range []string{
+		"", "0", "f", "FALSE", // etc
+	} {
+		os.Setenv(key, s)
+		c.Assert(os.Getenv(key), check.Equals, s)
+		c.Check(osutil.GetenvBool(key), check.Equals, false, check.Commentf(s))
+	}
+}

overlord/devicestate/devicemgr.go

@@ -41,6 +41,7 @@ import (
 	"github.com/snapcore/snapd/asserts"
 	"github.com/snapcore/snapd/dirs"
 	"github.com/snapcore/snapd/i18n"
+	"github.com/snapcore/snapd/osutil"
 	"github.com/snapcore/snapd/overlord/assertstate"
 	"github.com/snapcore/snapd/overlord/auth"
 	"github.com/snapcore/snapd/overlord/configstate"
@@ -359,7 +360,7 @@ func (m *DeviceManager) Stop() {
 }
 
 func useStaging() bool {
-	return os.Getenv("SNAPPY_USE_STAGING_STORE") == "1"
+	return osutil.GetenvBool("SNAPPY_USE_STAGING_STORE")
 }
 
 func deviceAPIBaseURL() string {

snap/squashfs/squashfs.go

@@ -63,7 +63,7 @@ func (s *Snap) Install(targetPath, mountDir string) error {
 	// snap when we "install" a squashfs snap in the tests.
 	// We can not mount it for real in the tests, so we just unpack
 	// it to the location which is good enough for the tests.
-	if os.Getenv("SNAPPY_SQUASHFS_UNPACK_FOR_TESTS") != "" {
+	if osutil.GetenvBool("SNAPPY_SQUASHFS_UNPACK_FOR_TESTS") {
 		if err := s.Unpack("*", mountDir); err != nil {
 			return err
 		}

store/logger_test.go

@@ -45,7 +45,7 @@ func (loggerSuite) TearDownTest(c *check.C) {
 }
 
 func (s *loggerSuite) SetUpTest(c *check.C) {
-	os.Setenv("SNAPD_DEBUG", "yes")
+	os.Setenv("SNAPD_DEBUG", "true")
 	s.logbuf = bytes.NewBuffer(nil)
 	l, err := logger.NewConsoleLog(s.logbuf, logger.DefaultFlags)
 	c.Assert(err, check.IsNil)

store/store.go

@@ -228,20 +228,20 @@ func getStructFields(s interface{}) []string {
 }
 
 func useDeltas() bool {
-	return os.Getenv("SNAPD_USE_DELTAS_EXPERIMENTAL") == "1"
+	return osutil.GetenvBool("SNAPD_USE_DELTAS_EXPERIMENTAL")
 }
 
 func useStaging() bool {
-	return os.Getenv("SNAPPY_USE_STAGING_STORE") == "1"
+	return osutil.GetenvBool("SNAPPY_USE_STAGING_STORE")
 }
 
 func cpiURL() string {
 	if useStaging() {
 		return "https://search.apps.staging.ubuntu.com/api/v1/"
 	}
 	// FIXME: this will become a store-url assertion
-	if os.Getenv("SNAPPY_FORCE_CPI_URL") != "" {
-		return os.Getenv("SNAPPY_FORCE_CPI_URL")
+	if u := os.Getenv("SNAPPY_FORCE_CPI_URL"); u != "" {
+		return u
 	}
 
 	return "https://search.apps.ubuntu.com/api/v1/"
@@ -255,8 +255,8 @@ func authLocation() string {
 }
 
 func authURL() string {
-	if os.Getenv("SNAPPY_FORCE_SSO_URL") != "" {
-		return os.Getenv("SNAPPY_FORCE_SSO_URL")
+	if u := os.Getenv("SNAPPY_FORCE_SSO_URL"); u != "" {
+		return u
 	}
 	return "https://" + authLocation() + "/api/v2"
 }
@@ -266,8 +266,8 @@ func assertsURL() string {
 		return "https://assertions.staging.ubuntu.com/v1/"
 	}
 
-	if os.Getenv("SNAPPY_FORCE_SAS_URL") != "" {
-		return os.Getenv("SNAPPY_FORCE_SAS_URL")
+	if u := os.Getenv("SNAPPY_FORCE_SAS_URL"); u != "" {
+		return u
 	}
 
 	return "https://assertions.ubuntu.com/v1/"