Merge lp:~alecu/unity-scope-snappy/use-testability into lp:~unity-api-team/unity-scope-snappy/trunk

[Alejandro J. Cura]

*** NOT READY YET ***
do not merge

Unmerged revisions

9. By Alejandro J. Cura on 2015-05-21

First attempt at adding interfaces for exported types, to ease testing.

=== modified file 'snappy-scope/main.go'
--- snappy-scope/main.go	2015-05-20 13:02:51 +0000
+++ snappy-scope/main.go	2015-05-21 22:24:46 +0000
@@ -9,7 +9,7 @@
 )
 
 type SnappyScope struct {
-	webdmClient *webdm.Client
+	webdmClient webdm.Webdm
 }
 
 func (scope *SnappyScope) SetScopeBase(base *scopes.ScopeBase) {
@@ -31,7 +31,7 @@
         }
 }`
 
-func (scope SnappyScope) Search(query *scopes.CannedQuery, metadata *scopes.SearchMetadata, reply *scopes.SearchReply, cancelled <-chan bool) error {
+func (scope SnappyScope) Search(query scopes.CannedQueryInterface, metadata scopes.SearchMetadataInterface, reply scopes.SearchReplyInterface, cancelled <-chan bool) error {
 	packages, err := scope.webdmClient.GetStorePackages()
 	if err != nil {
 		errorString := fmt.Sprintf("unity-scope-snappy: Unable to retrieve store packages: %s",

=== added file 'snappy-scope/main_test.go'
--- snappy-scope/main_test.go	1970-01-01 00:00:00 +0000
+++ snappy-scope/main_test.go	2015-05-21 22:24:46 +0000
@@ -0,0 +1,124 @@
+package main
+
+import (
+    "testing"
+	"launchpad.net/go-unityscopes/v2"
+	"launchpad.net/unity-scope-snappy/webdm"
+)
+
+type fakeWebdmClient struct {
+    storePackages []webdm.Package
+    installedPackages []webdm.Package
+}
+
+func (client *fakeWebdmClient) GetStorePackages() ([]webdm.Package, error) {
+    return client.storePackages, nil
+}
+
+func (client *fakeWebdmClient) GetInstalledPackages() ([]webdm.Package, error) {
+    return client.installedPackages, nil
+}
+
+// Fake cannedQuery
+type fakeCannedQuery struct {
+    departmentID string
+    queryString string
+}
+
+func (query *fakeCannedQuery) ScopeID() string {
+    return "fake scope id"
+}
+
+func (query *fakeCannedQuery) DepartmentID() string {
+    return query.departmentID
+}
+
+func (query *fakeCannedQuery) QueryString() string {
+    return query.queryString
+}
+
+func (query *fakeCannedQuery) FilterState() scopes.FilterState {
+    return nil
+}
+
+func (query *fakeCannedQuery) SetDepartmentID(departmentID string) {
+    query.departmentID = departmentID
+}
+
+func (query *fakeCannedQuery) SetQueryString(queryString string) {
+    query.queryString = queryString
+}
+
+func (query *fakeCannedQuery) ToURI() string {
+    return "fake://uri/" + query.ScopeID()
+}
+
+// Fake search metadata
+type fakeSearchMetadata struct {
+    location *scopes.Location
+    keywords []string
+}
+
+func (metadata *fakeSearchMetadata) Cardinality() int {
+    return 0
+}
+
+func (metadata *fakeSearchMetadata) Location() *scopes.Location {
+    return metadata.location
+}
+
+func (metadata *fakeSearchMetadata) SetLocation(l *scopes.Location) error {
+    metadata.location = l
+    return nil
+}
+
+func (metadata *fakeSearchMetadata) SetAggregatedKeywords(keywords []string) error {
+    metadata.keywords = keywords
+    return nil
+}
+
+func (metadata *fakeSearchMetadata) AggregatedKeywords() []string {
+    return metadata.keywords
+}
+
+func (metadata *fakeSearchMetadata) IsAggregated() bool {
+    return true
+}
+
+
+// Fake search reply
+type fakeSearchReply struct {
+}
+
+func (reply *fakeSearchReply) Finished() {
+}
+
+func (reply *fakeSearchReply) Error(err error) {
+}
+
+func (reply *fakeSearchReply) RegisterCategory(id, title, icon, template string) *scopes.Category {
+    return nil
+}
+
+func (reply *fakeSearchReply) RegisterDepartments(parent *scopes.Department) {
+}
+
+func (reply *fakeSearchReply) Push(result *scopes.CategorisedResult) error {
+    return nil
+}
+
+func (reply *fakeSearchReply) PushFilters(filters []scopes.Filter, state scopes.FilterState) error {
+    return nil
+}
+
+
+func TestSearch(t *testing.T) {
+    scope := new(SnappyScope)
+    scope.webdmClient = new(fakeWebdmClient)
+
+    query := new(fakeCannedQuery)
+    metadata := new(fakeSearchMetadata)
+    reply := new(fakeSearchReply)
+
+    scope.Search(query, metadata, reply, nil)
+}

=== modified file 'webdm/client.go'
--- webdm/client.go	2015-05-20 13:02:51 +0000
+++ webdm/client.go	2015-05-21 22:24:46 +0000
@@ -23,6 +23,12 @@
 	apiDefaultIconPath = "/public/images/default-package-icon.svg"
 )
 
+// exported methods of the webdm client
+type Webdm interface {
+    GetInstalledPackages() ([]Package, error)
+    GetStorePackages() ([]Package, error)
+}
+
 // UnmarshallJSON exists to decode the Status field in the json into an
 // "Installed" boolean
 func (s *Status) UnmarshalJSON(data []byte) error {