many: introduce snapdenv.UseStagingStore

asserts/sysdb/generic.go

@@ -1,7 +1,7 @@
 // -*- Mode: Go; indent-tabs-mode: t -*-
 
 /*
- * Copyright (C) 2017 Canonical Ltd
+ * Copyright (C) 2017-2020 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
@@ -23,7 +23,7 @@ import (
 	"fmt"
 
 	"github.com/snapcore/snapd/asserts"
-	"github.com/snapcore/snapd/osutil"
+	"github.com/snapcore/snapd/snapdenv"
 )
 
 const (
@@ -152,7 +152,7 @@ func init() {
 // Generic returns a copy of the current set of predefined assertions for the 'generic' authority as used by Open.
 func Generic() []asserts.Assertion {
 	generic := []asserts.Assertion(nil)
-	if !osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if !snapdenv.UseStagingStore() {
 		generic = append(generic, genericAssertions...)
 	} else {
 		generic = append(generic, genericStagingAssertions...)
@@ -179,7 +179,7 @@ func GenericClassicModel() *asserts.Model {
 	if genericClassicModelOverride != nil {
 		return genericClassicModelOverride
 	}
-	if !osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if !snapdenv.UseStagingStore() {
 		return genericClassicModel
 	} else {
 		return genericStagingClassicModel

asserts/sysdb/trusted.go

@@ -1,7 +1,7 @@
 // -*- Mode: Go; indent-tabs-mode: t -*-
 
 /*
- * Copyright (C) 2016 Canonical Ltd
+ * Copyright (C) 2016-2020 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
@@ -23,7 +23,7 @@ import (
 	"fmt"
 
 	"github.com/snapcore/snapd/asserts"
-	"github.com/snapcore/snapd/osutil"
+	"github.com/snapcore/snapd/snapdenv"
 )
 
 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 !osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if !snapdenv.UseStagingStore() {
 		trusted = append(trusted, trustedAssertions...)
 	} else {
 		if len(trustedStagingAssertions) == 0 {

cmd/snap-repair/cmd_run.go

@@ -1,7 +1,7 @@
 // -*- Mode: Go; indent-tabs-mode: t -*-
 
 /*
- * Copyright (C) 2017 Canonical Ltd
+ * Copyright (C) 2017-2020 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
@@ -27,6 +27,7 @@ import (
 
 	"github.com/snapcore/snapd/dirs"
 	"github.com/snapcore/snapd/osutil"
+	"github.com/snapcore/snapd/snapdenv"
 )
 
 func init() {
@@ -47,7 +48,7 @@ var baseURL *url.URL
 
 func init() {
 	var baseurl string
-	if osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if snapdenv.UseStagingStore() {
 		baseurl = "https://api.staging.snapcraft.io/v2/"
 	} else {
 		baseurl = "https://api.snapcraft.io/v2/"

cmd/snap-repair/staging.go

@@ -2,7 +2,7 @@
 // +build withtestkeys withstagingkeys
 
 /*
- * Copyright (C) 2017 Canonical Ltd
+ * Copyright (C) 2017-2020 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
@@ -24,7 +24,7 @@ import (
 	"fmt"
 
 	"github.com/snapcore/snapd/asserts"
-	"github.com/snapcore/snapd/osutil"
+	"github.com/snapcore/snapd/snapdenv"
 )
 
 const (
@@ -75,7 +75,7 @@ func init() {
 	if err != nil {
 		panic(fmt.Sprintf("cannot decode trusted account-key: %v", err))
 	}
-	if osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if snapdenv.UseStagingStore() {
 		trustedRepairRootKeys = append(trustedRepairRootKeys, repairRootAccountKey.(*asserts.AccountKey))
 	}
 }

cmd/snap-repair/trusted.go

@@ -1,7 +1,7 @@
 // -*- Mode: Go; indent-tabs-mode: t -*-
 
 /*
- * Copyright (C) 2017 Canonical Ltd
+ * Copyright (C) 2017-2020 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
@@ -23,7 +23,7 @@ import (
 	"fmt"
 
 	"github.com/snapcore/snapd/asserts"
-	"github.com/snapcore/snapd/osutil"
+	"github.com/snapcore/snapd/snapdenv"
 )
 
 const (
@@ -83,7 +83,7 @@ func init() {
 	if err != nil {
 		panic(fmt.Sprintf("cannot decode trusted account-key: %v", err))
 	}
-	if !osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if !snapdenv.UseStagingStore() {
 		trustedRepairRootKeys = append(trustedRepairRootKeys, repairRootAccountKey.(*asserts.AccountKey))
 	}
 }

image/helpers.go

@@ -46,6 +46,7 @@ import (
 	"github.com/snapcore/snapd/progress"
 	"github.com/snapcore/snapd/release"
 	"github.com/snapcore/snapd/snap"
+	"github.com/snapcore/snapd/snapdenv"
 	"github.com/snapcore/snapd/store"
 	"github.com/snapcore/snapd/strutil"
 )
@@ -127,7 +128,7 @@ func parseAuthFile(authFn string, data []byte) (*authData, error) {
 }
 
 func snapcraftLoginSection() string {
-	if osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if snapdenv.UseStagingStore() {
 		return "login.staging.ubuntu.com"
 	}
 	return "login.ubuntu.com"

overlord/devicestate/handlers_serial.go

@@ -36,7 +36,6 @@ import (
 	"github.com/snapcore/snapd/asserts"
 	"github.com/snapcore/snapd/httputil"
 	"github.com/snapcore/snapd/logger"
-	"github.com/snapcore/snapd/osutil"
 	"github.com/snapcore/snapd/overlord/assertstate"
 	"github.com/snapcore/snapd/overlord/auth"
 	"github.com/snapcore/snapd/overlord/configstate/config"
@@ -47,12 +46,8 @@ import (
 	"github.com/snapcore/snapd/timings"
 )
 
-func useStaging() bool {
-	return osutil.GetenvBool("SNAPPY_USE_STAGING_STORE")
-}
-
 func baseURL() *url.URL {
-	if useStaging() {
+	if snapdenv.UseStagingStore() {
 		return mustParse("https://api.staging.snapcraft.io/")
 	}
 	return mustParse("https://api.snapcraft.io/")

snapdenv/snapdenv.go

@@ -55,3 +55,21 @@ func MockTesting(testing bool) (restore func()) {
 		mockTesting = old
 	}
 }
+
+var mockUseStagingStore *bool
+
+// UseStagingStore returns whether snapd compontents should use the staging store.
+func UseStagingStore() bool {
+	if mockUseStagingStore != nil {
+		return *mockUseStagingStore
+	}
+	return osutil.GetenvBool("SNAPPY_USE_STAGING_STORE")
+}
+
+func MockUseStagingStore(testing bool) (restore func()) {
+	old := mockUseStagingStore
+	mockUseStagingStore = &testing
+	return func() {
+		mockUseStagingStore = old
+	}
+}

snapdenv/snapdenv_test.go

@@ -70,3 +70,40 @@ func (s *snapdenvSuite) TestMockTesting(c *C) {
 	snapdenv.MockTesting(false)
 	c.Check(snapdenv.Testing(), Equals, false)
 }
+
+func (s *snapdenvSuite) TestUseStagingStore(c *C) {
+	oldUseStagingStore := os.Getenv("SNAPPY_USE_STAGING_STORE")
+	defer func() {
+		if oldUseStagingStore == "" {
+			os.Unsetenv("SNAPPY_USE_STAGING_STORE")
+		} else {
+			os.Setenv("SNAPPY_USE_STAGING_STORE", oldUseStagingStore)
+		}
+	}()
+
+	os.Setenv("SNAPPY_USE_STAGING_STORE", "1")
+	c.Check(snapdenv.UseStagingStore(), Equals, true)
+
+	os.Unsetenv("SNAPPY_USE_STAGING_STORE")
+	c.Check(snapdenv.UseStagingStore(), Equals, false)
+}
+
+func (s *snapdenvSuite) TestMockUseStagingStore(c *C) {
+	oldUseStagingStore := os.Getenv("SNAPPY_USE_STAGING_STORE")
+	defer func() {
+		if oldUseStagingStore == "" {
+			os.Unsetenv("SNAPPY_USE_STAGING_STORE")
+		} else {
+			os.Setenv("SNAPPY_USE_STAGING_STORE", oldUseStagingStore)
+		}
+	}()
+	os.Unsetenv("SNAPPY_USE_STAGING_STORE")
+
+	r := snapdenv.MockUseStagingStore(true)
+	defer r()
+
+	c.Check(snapdenv.UseStagingStore(), Equals, true)
+
+	snapdenv.MockUseStagingStore(false)
+	c.Check(snapdenv.UseStagingStore(), Equals, false)
+}

store/store.go

@@ -207,10 +207,6 @@ func useDeltas() bool {
 	return osutil.GetenvBool("SNAPD_USE_DELTAS_EXPERIMENTAL", true)
 }
 
-func useStaging() bool {
-	return osutil.GetenvBool("SNAPPY_USE_STAGING_STORE")
-}
-
 // endpointURL clones a base URL and updates it with optional path and query.
 func endpointURL(base *url.URL, path string, query url.Values) *url.URL {
 	u := *base
@@ -227,7 +223,7 @@ func endpointURL(base *url.URL, path string, query url.Values) *url.URL {
 // apiURL returns the system default base API URL.
 func apiURL() *url.URL {
 	s := "https://api.snapcraft.io/"
-	if useStaging() {
+	if snapdenv.UseStagingStore() {
 		s = "https://api.staging.snapcraft.io/"
 	}
 	u, _ := url.Parse(s)
@@ -274,7 +270,7 @@ func assertsURL() (*url.URL, error) {
 }
 
 func authLocation() string {
-	if useStaging() {
+	if snapdenv.UseStagingStore() {
 		return "login.staging.ubuntu.com"
 	}
 	return "login.ubuntu.com"
@@ -290,7 +286,7 @@ func authURL() string {
 var defaultStoreDeveloperURL = "https://dashboard.snapcraft.io/"
 
 func storeDeveloperURL() string {
-	if useStaging() {
+	if snapdenv.UseStagingStore() {
 		return "https://dashboard.staging.snapcraft.io/"
 	}
 	return defaultStoreDeveloperURL

store/store_test.go

@@ -3458,33 +3458,30 @@ func (s *storeTestSuite) TestFindClientUserAgent(c *C) {
 }
 
 func (s *storeTestSuite) TestAuthLocationDependsOnEnviron(c *C) {
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", ""), IsNil)
+	defer snapdenv.MockUseStagingStore(false)()
 	before := store.AuthLocation()
 
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", "1"), IsNil)
-	defer os.Setenv("SNAPPY_USE_STAGING_STORE", "")
+	snapdenv.MockUseStagingStore(true)
 	after := store.AuthLocation()
 
 	c.Check(before, Not(Equals), after)
 }
 
 func (s *storeTestSuite) TestAuthURLDependsOnEnviron(c *C) {
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", ""), IsNil)
+	defer snapdenv.MockUseStagingStore(false)()
 	before := store.AuthURL()
 
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", "1"), IsNil)
-	defer os.Setenv("SNAPPY_USE_STAGING_STORE", "")
+	snapdenv.MockUseStagingStore(true)
 	after := store.AuthURL()
 
 	c.Check(before, Not(Equals), after)
 }
 
 func (s *storeTestSuite) TestApiURLDependsOnEnviron(c *C) {
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", ""), IsNil)
+	defer snapdenv.MockUseStagingStore(false)()
 	before := store.ApiURL()
 
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", "1"), IsNil)
-	defer os.Setenv("SNAPPY_USE_STAGING_STORE", "")
+	snapdenv.MockUseStagingStore(true)
 	after := store.ApiURL()
 
 	c.Check(before, Not(Equals), after)
@@ -3532,11 +3529,10 @@ func (s *storeTestSuite) TestStoreURLBadEnvironCPI(c *C) {
 }
 
 func (s *storeTestSuite) TestStoreDeveloperURLDependsOnEnviron(c *C) {
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", ""), IsNil)
+	defer snapdenv.MockUseStagingStore(false)()
 	before := store.StoreDeveloperURL()
 
-	c.Assert(os.Setenv("SNAPPY_USE_STAGING_STORE", "1"), IsNil)
-	defer os.Setenv("SNAPPY_USE_STAGING_STORE", "")
+	snapdenv.MockUseStagingStore(true)
 	after := store.StoreDeveloperURL()
 
 	c.Check(before, Not(Equals), after)

tests/lib/fakestore/store/store.go

@@ -1,7 +1,7 @@
 // -*- Mode: Go; indent-tabs-mode: t -*-
 
 /*
- * Copyright (C) 2016-2018 Canonical Ltd
+ * Copyright (C) 2016-2020 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
@@ -36,7 +36,6 @@ import (
 	"github.com/snapcore/snapd/asserts"
 	"github.com/snapcore/snapd/asserts/sysdb"
 	"github.com/snapcore/snapd/asserts/systestkeys"
-	"github.com/snapcore/snapd/osutil"
 	"github.com/snapcore/snapd/snap"
 	"github.com/snapcore/snapd/snapdenv"
 	"github.com/snapcore/snapd/store"
@@ -391,7 +390,7 @@ func (s *Store) bulkEndpoint(w http.ResponseWriter, req *http.Request) {
 	}
 
 	var remoteStore string
-	if osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if snapdenv.UseStagingStore() {
 		remoteStore = "staging"
 	} else {
 		remoteStore = "production"
@@ -556,7 +555,7 @@ func (s *Store) snapActionEndpoint(w http.ResponseWriter, req *http.Request) {
 	}
 
 	var remoteStore string
-	if osutil.GetenvBool("SNAPPY_USE_STAGING_STORE") {
+	if snapdenv.UseStagingStore() {
 		remoteStore = "staging"
 	} else {
 		remoteStore = "production"