store, cmd/snapd: send a basic user-agent to the store

canonical · Jun 28, 2016 · af25c42 · af25c42
1 parent d57b958
commit af25c42
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/cmd/snapd/main.go b/cmd/snapd/main.go
@@ -28,6 +28,7 @@ import (
 	"github.com/snapcore/snapd/cmd"
 	"github.com/snapcore/snapd/daemon"
 	"github.com/snapcore/snapd/logger"
+	"github.com/snapcore/snapd/store"
 )
 
 func init() {
@@ -46,6 +47,8 @@ func main() {
 }
 
 func run() error {
+	store.UserAgent = "snapd/" + cmd.Version
+
 	d, err := daemon.New()
 	if err != nil {
 		return err

diff --git a/store/auth.go b/store/auth.go
@@ -64,6 +64,7 @@ func RequestPackageAccessMacaroon() (string, error) {
 	if err != nil {
 		return "", fmt.Errorf(errorPrefix+"%v", err)
 	}
+	req.Header.Set("User-Agent", UserAgent)
 	req.Header.Set("accept", "application/json")
 	req.Header.Set("content-type", "application/json")
 
@@ -114,6 +115,7 @@ func DischargeAuthCaveat(username, password, macaroon, otp string) (string, erro
 	if err != nil {
 		return "", fmt.Errorf(errorPrefix+"%v", err)
 	}
+	req.Header.Set("User-Agent", UserAgent)
 	req.Header.Set("accept", "application/json")
 	req.Header.Set("content-type", "application/json")
 

diff --git a/store/store.go b/store/store.go
@@ -51,6 +51,10 @@ const (
 	UbuntuCoreWireProtocol = "1"
 )
 
+// UserAgent to send
+// xxx: this should actually be set per client request, and include the client user agent
+var UserAgent = "unset"
+
 func infoFromRemote(d snapDetails) *snap.Info {
 	info := &snap.Info{}
 	info.Architectures = d.Architectures
@@ -228,6 +232,7 @@ func (s *SnapUbuntuStoreRepository) setUbuntuStoreHeaders(req *http.Request, cha
 		auther.Authenticate(req)
 	}
 
+	req.Header.Set("User-Agent", UserAgent)
 	req.Header.Set("Accept", "application/hal+json,application/json")
 	req.Header.Set("X-Ubuntu-Architecture", string(arch.UbuntuArchitecture()))
 	req.Header.Set("X-Ubuntu-Release", release.Series)
@@ -737,6 +742,7 @@ func (s *SnapUbuntuStoreRepository) Assertion(assertType *asserts.AssertionType,
 	if auther != nil {
 		auther.Authenticate(req)
 	}
+	req.Header.Set("User-Agent", UserAgent)
 	req.Header.Set("Accept", asserts.MediaType)
 
 	resp, err := s.client.Do(req)

diff --git a/store/store_test.go b/store/store_test.go
@@ -105,6 +105,7 @@ func (t *remoteRepoTestSuite) TestAuthenticatedDownloadDoesNotUseAnonURL(c *C) {
 		// check authorization is set
 		authorization := req.Header.Get("Authorization")
 		c.Check(authorization, Equals, "Authorization-details")
+		c.Check(req.UserAgent(), Equals, UserAgent)
 
 		c.Check(req.URL.String(), Equals, "AUTH-URL")
 		w.Write([]byte("I was downloaded"))
@@ -174,6 +175,8 @@ func (t *remoteRepoTestSuite) TestUbuntuStoreRepositoryHeaders(c *C) {
 
 	t.store.setUbuntuStoreHeaders(req, "", false, nil)
 
+	c.Check(req.UserAgent(), Equals, UserAgent)
+
 	c.Check(req.Header.Get("X-Ubuntu-Release"), Equals, "16")
 	c.Check(req.Header.Get("X-Ubuntu-Device-Channel"), Equals, "")
 	c.Check(req.Header.Get("X-Ubuntu-Confinement"), Equals, "")
@@ -301,6 +304,8 @@ const mockPurchaseJSON = `[
 
 func (t *remoteRepoTestSuite) TestUbuntuStoreRepositoryDetails(c *C) {
 	mockServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		c.Check(r.UserAgent(), Equals, UserAgent)
+
 		// no store ID by default
 		storeID := r.Header.Get("X-Ubuntu-Store")
 		c.Check(storeID, Equals, "")
@@ -360,6 +365,7 @@ func (t *remoteRepoTestSuite) TestUbuntuStoreRepositoryDetailsSetsAuth(c *C) {
 		// check authorization is set
 		authorization := r.Header.Get("Authorization")
 		c.Check(authorization, Equals, "Authorization-details")
+		c.Check(r.UserAgent(), Equals, UserAgent)
 
 		io.WriteString(w, MockDetailsJSON)
 	}))
@@ -368,6 +374,7 @@ func (t *remoteRepoTestSuite) TestUbuntuStoreRepositoryDetailsSetsAuth(c *C) {
 	defer mockServer.Close()
 
 	mockPurchasesServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		c.Check(r.UserAgent(), Equals, UserAgent)
 		// check authorization is set
 		authorization := r.Header.Get("Authorization")
 		c.Check(authorization, Equals, "Authorization-details")
@@ -550,6 +557,7 @@ const MockSearchJSON = `{
 
 func (t *remoteRepoTestSuite) TestUbuntuStoreFind(c *C) {
 	mockServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		c.Check(r.UserAgent(), Equals, UserAgent)
 		c.Check(r.URL.RawQuery, Equals, "q=hello")
 		w.Header().Set("Content-Type", "application/hal+json")
 		io.WriteString(w, MockSearchJSON)
@@ -643,6 +651,7 @@ func (t *remoteRepoTestSuite) TestUbuntuStoreFindBadBoody(c *C) {
 
 func (t *remoteRepoTestSuite) TestUbuntuStoreFindSetsAuth(c *C) {
 	mockServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		c.Check(r.UserAgent(), Equals, UserAgent)
 		// check authorization is set
 		authorization := r.Header.Get("Authorization")
 		c.Check(authorization, Equals, "Authorization-details")
@@ -655,6 +664,7 @@ func (t *remoteRepoTestSuite) TestUbuntuStoreFindSetsAuth(c *C) {
 	defer mockServer.Close()
 
 	mockPurchasesServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		c.Check(r.UserAgent(), Equals, UserAgent)
 		authorization := r.Header.Get("Authorization")
 		c.Check(authorization, Equals, "Authorization-details")
 		c.Check(r.URL.Path, Equals, "/dev/api/snap-purchases/"+helloWorldSnapID+"/")