auth
auth/client_test.go
The great documentation and exported interface cleanup. Modify all our *Store interfaces to be unexported, as there's no real good reason they need to be exported, especially as they can be implemented without being exported. The interfaces shouldn't matter to 99% of users of the package, so let's not pollute our package API. Further, all methods of the interfaces are now unexported, for pretty much the same reasoning. Add a doc.go file with documentation explaining the choices the package is making and what it provides. Implement documentation on all our exported types and methods and functions, which makes golint happy. The only remaining golint warning is about NewMemstore, which will stay the way it is. The memstore type is useful outside tests for things like standing up a server quickly when we don't care about the storage, and because the type is unexported, we _need_ a New function to create an instance that can be passed to the Context.
1.1 --- a/client_test.go Wed Oct 22 00:30:28 2014 -0400 1.2 +++ b/client_test.go Sun Oct 26 00:53:36 2014 -0400 1.3 @@ -18,7 +18,7 @@ 1.4 clientChangeWebsite 1.5 ) 1.6 1.7 -var clientStores = []ClientStore{NewMemstore()} 1.8 +var clientStores = []clientStore{NewMemstore()} 1.9 1.10 func compareClients(client1, client2 Client) (success bool, field string, val1, val2 interface{}) { 1.11 if !client1.ID.Equal(client2.ID) { 1.12 @@ -72,15 +72,15 @@ 1.13 Website: "website", 1.14 } 1.15 for _, store := range clientStores { 1.16 - err := store.SaveClient(client) 1.17 + err := store.saveClient(client) 1.18 if err != nil { 1.19 t.Fatalf("Error saving client to %T: %s", store, err) 1.20 } 1.21 - err = store.SaveClient(client) 1.22 + err = store.saveClient(client) 1.23 if err != ErrClientAlreadyExists { 1.24 t.Fatalf("Expected ErrClientAlreadyExists, got %v from %T", err, store) 1.25 } 1.26 - retrieved, err := store.GetClient(client.ID) 1.27 + retrieved, err := store.getClient(client.ID) 1.28 if err != nil { 1.29 t.Fatalf("Error retrieving client from %T: %s", store, err) 1.30 } 1.31 @@ -88,7 +88,7 @@ 1.32 if !success { 1.33 t.Fatalf("Expected field %s to be %v, but %T returned %v", field, expectation, store, result) 1.34 } 1.35 - clients, err := store.ListClientsByOwner(client.OwnerID, 25, 0) 1.36 + clients, err := store.listClientsByOwner(client.OwnerID, 25, 0) 1.37 if err != nil { 1.38 t.Fatalf("Error retrieving clients by owner from %T: %s", store, err) 1.39 } 1.40 @@ -99,19 +99,19 @@ 1.41 if !success { 1.42 t.Fatalf("Expected field %s to be %v, but %T returned %v", field, expectation, store, result) 1.43 } 1.44 - err = store.DeleteClient(client.ID) 1.45 + err = store.deleteClient(client.ID) 1.46 if err != nil { 1.47 t.Fatalf("Error deleting client from %T: %s", store, err) 1.48 } 1.49 - err = store.DeleteClient(client.ID) 1.50 + err = store.deleteClient(client.ID) 1.51 if err != ErrClientNotFound { 1.52 t.Fatalf("Expected ErrClientNotFound, got %s from %T", err, store) 1.53 } 1.54 - retrieved, err = store.GetClient(client.ID) 1.55 + retrieved, err = store.getClient(client.ID) 1.56 if err != ErrClientNotFound { 1.57 t.Fatalf("Expected ErrClientNotFound from %T, got %+v and %s", store, retrieved, err) 1.58 } 1.59 - clients, err = store.ListClientsByOwner(client.OwnerID, 25, 0) 1.60 + clients, err = store.listClientsByOwner(client.OwnerID, 25, 0) 1.61 if err != nil { 1.62 t.Fatalf("Error listing clients by owner from %T: %s", store, err) 1.63 } 1.64 @@ -146,15 +146,15 @@ 1.65 URI: *uri2, 1.66 } 1.67 for _, store := range clientStores { 1.68 - err := store.SaveClient(client) 1.69 + err := store.saveClient(client) 1.70 if err != nil { 1.71 t.Fatalf("Error saving client to %T: %s", store, err) 1.72 } 1.73 - err = store.AddEndpoint(client.ID, endpoint1) 1.74 + err = store.addEndpoint(client.ID, endpoint1) 1.75 if err != nil { 1.76 t.Fatalf("Error adding endpoint to client in %T: %s", store, err) 1.77 } 1.78 - endpoints, err := store.ListEndpoints(client.ID, 10, 0) 1.79 + endpoints, err := store.listEndpoints(client.ID, 10, 0) 1.80 if err != nil { 1.81 t.Fatalf("Error retrieving endpoints from %T: %s", store, err) 1.82 } 1.83 @@ -165,11 +165,11 @@ 1.84 if !success { 1.85 t.Fatalf("Expected field %s to be %v, but %T returned %v", field, expectation, store, result) 1.86 } 1.87 - err = store.AddEndpoint(client.ID, endpoint2) 1.88 + err = store.addEndpoint(client.ID, endpoint2) 1.89 if err != nil { 1.90 t.Fatalf("Error adding endpoint to client in %T: %s", store, err) 1.91 } 1.92 - endpoints, err = store.ListEndpoints(client.ID, 10, 0) 1.93 + endpoints, err = store.listEndpoints(client.ID, 10, 0) 1.94 if err != nil { 1.95 t.Fatalf("Error retrieving endpoints from %T: %s", store, err) 1.96 } 1.97 @@ -187,11 +187,11 @@ 1.98 if !success { 1.99 t.Fatalf("Expected field %s to be %v, but %T returned %v", field, expectation, store, result) 1.100 } 1.101 - err = store.RemoveEndpoint(client.ID, endpoint1.ID) 1.102 + err = store.removeEndpoint(client.ID, endpoint1.ID) 1.103 if err != nil { 1.104 t.Fatalf("Error removing endpoint from client in %T: %s", store, err) 1.105 } 1.106 - endpoints, err = store.ListEndpoints(client.ID, 10, 0) 1.107 + endpoints, err = store.listEndpoints(client.ID, 10, 0) 1.108 if err != nil { 1.109 t.Fatalf("Error listing endpoints in %T: %s", store, err) 1.110 } 1.111 @@ -202,11 +202,11 @@ 1.112 if !success { 1.113 t.Fatalf("Expected field %s to be %v, but %T returned %v", field, expectation, store, result) 1.114 } 1.115 - err = store.RemoveEndpoint(client.ID, endpoint2.ID) 1.116 + err = store.removeEndpoint(client.ID, endpoint2.ID) 1.117 if err != nil { 1.118 t.Fatalf("Error removing endpoint from client in %T: %s", store, err) 1.119 } 1.120 - endpoints, err = store.ListEndpoints(client.ID, 10, 0) 1.121 + endpoints, err = store.listEndpoints(client.ID, 10, 0) 1.122 if err != nil { 1.123 t.Fatalf("Error listing endpoints in %T: %s", store, err) 1.124 } 1.125 @@ -262,15 +262,15 @@ 1.126 t.Fatalf("Expected field `%s` to be `%v`, got `%v`", field, expected, got) 1.127 } 1.128 for _, store := range clientStores { 1.129 - err := store.SaveClient(client) 1.130 + err := store.saveClient(client) 1.131 if err != nil { 1.132 t.Fatalf("Error saving client in %T: %s", store, err) 1.133 } 1.134 - err = store.UpdateClient(client.ID, change) 1.135 + err = store.updateClient(client.ID, change) 1.136 if err != nil { 1.137 t.Fatalf("Error updating client in %T: %s", store, err) 1.138 } 1.139 - retrieved, err := store.GetClient(client.ID) 1.140 + retrieved, err := store.getClient(client.ID) 1.141 if err != nil { 1.142 t.Fatalf("Error getting profile from %T: %s", store, err) 1.143 } 1.144 @@ -278,11 +278,11 @@ 1.145 if !match { 1.146 t.Fatalf("Expected field `%s` to be `%v`, got `%v` from %T", field, expected, got, store) 1.147 } 1.148 - err = store.DeleteClient(client.ID) 1.149 + err = store.deleteClient(client.ID) 1.150 if err != nil { 1.151 t.Fatalf("Error deleting client from %T: %s", store, err) 1.152 } 1.153 - err = store.UpdateClient(client.ID, change) 1.154 + err = store.updateClient(client.ID, change) 1.155 if err != ErrClientNotFound { 1.156 t.Fatalf("Expected ErrClientNotFound, got %v from %T", err, store) 1.157 } 1.158 @@ -322,20 +322,20 @@ 1.159 "https://www.example.com/my/full/path": true, 1.160 } 1.161 for _, store := range clientStores { 1.162 - err := store.SaveClient(client) 1.163 + err := store.saveClient(client) 1.164 if err != nil { 1.165 t.Fatalf("Error saving client in %T: %s", store, err) 1.166 } 1.167 - err = store.AddEndpoint(client.ID, endpoint1) 1.168 + err = store.addEndpoint(client.ID, endpoint1) 1.169 if err != nil { 1.170 t.Fatalf("Error saving endpoint in %T: %s", store, err) 1.171 } 1.172 - err = store.AddEndpoint(client.ID, endpoint2) 1.173 + err = store.addEndpoint(client.ID, endpoint2) 1.174 if err != nil { 1.175 t.Fatalf("Error saving endpoint in %T: %s", store, err) 1.176 } 1.177 for candidate, expectation := range candidates { 1.178 - result, err := store.CheckEndpoint(client.ID, candidate, false) 1.179 + result, err := store.checkEndpoint(client.ID, candidate, false) 1.180 if err != nil { 1.181 t.Fatalf("Error checking endpoint %s in %T: %s", candidate, store, err) 1.182 } 1.183 @@ -384,20 +384,20 @@ 1.184 "https://www.example.com/my/full/path": true, 1.185 } 1.186 for _, store := range clientStores { 1.187 - err := store.SaveClient(client) 1.188 + err := store.saveClient(client) 1.189 if err != nil { 1.190 t.Fatalf("Error saving client in %T: %s", store, err) 1.191 } 1.192 - err = store.AddEndpoint(client.ID, endpoint1) 1.193 + err = store.addEndpoint(client.ID, endpoint1) 1.194 if err != nil { 1.195 t.Fatalf("Error saving endpoint in %T: %s", store, err) 1.196 } 1.197 - err = store.AddEndpoint(client.ID, endpoint2) 1.198 + err = store.addEndpoint(client.ID, endpoint2) 1.199 if err != nil { 1.200 t.Fatalf("Error saving endpoint in %T: %s", store, err) 1.201 } 1.202 for candidate, expectation := range candidates { 1.203 - result, err := store.CheckEndpoint(client.ID, candidate, true) 1.204 + result, err := store.checkEndpoint(client.ID, candidate, true) 1.205 if err != nil { 1.206 t.Fatalf("Error checking endpoint %s in %T: %s", candidate, store, err) 1.207 }