Merge lp:~jtv/gwacl/unexport-x509 into lp:gwacl

[Jeroen T. Vermeulen]

Un-export the X509 classes. They're an implementation detail, completely hidden from the gwacl API.

Cleaning up the public API that we expose for gwacl.

I regret the size of this diff. Just un-exporting some identifiers is a huge amount of pointless diff in Go. I figured for that very reason it'd be best to get this behind us as soon as possible, with a minimum of development going on for it to interfere with.

For what it's worth, the un-exporting of these items is the *only* thing that happens in this branch. It's a mechanical change: X509Request / X509Response / X509Session structs become x509Request / x509Response / x509Session respectively, and their constructors NewX509* become newX509* (insofar as they weren't lower-cased already).

Jeroen

[Julian Edwards (julian-edwards)]

"Just un-exporting some identifiers is a huge amount of pointless diff in Go"

Sigh :/

review: Approve

[Julian Edwards (julian-edwards)]

Attempt to merge into lp:gwacl failed due to conflicts:

text conflict in managementapi_test.go

[Julian Edwards (julian-edwards)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'managementapi.go'
--- managementapi.go	2013-03-25 02:10:02 +0000
+++ managementapi.go	2013-03-26 08:56:20 +0000
@@ -8,13 +8,13 @@
 )
 
 type ManagementAPI struct {
-    session *X509Session
+    session *x509Session
 }
 
 // NewManagementAPI creates an object used to interact with Windows Azure's API.
 // http://msdn.microsoft.com/en-us/library/windowsazure/ff800682.aspx
 func NewManagementAPI(subscriptionId string, certFile string) (*ManagementAPI, error) {
-    session, err := NewX509Session(subscriptionId, certFile)
+    session, err := newX509Session(subscriptionId, certFile)
     if err != nil {
         return nil, err
     }

=== modified file 'managementapi_test.go'
--- managementapi_test.go	2013-03-26 07:00:46 +0000
+++ managementapi_test.go	2013-03-26 08:56:20 +0000
@@ -21,7 +21,7 @@
     api, err := NewManagementAPI(subscriptionId, certFile)
 
     c.Assert(err, IsNil)
-    session, err := NewX509Session(subscriptionId, certFile)
+    session, err := newX509Session(subscriptionId, certFile)
     c.Assert(api.session.subscriptionId, DeepEquals, session.subscriptionId)
     c.Assert(api.session.certFile, DeepEquals, session.certFile)
 }
@@ -37,20 +37,20 @@
 // setUpDispatcher sets up a request dispatcher that:
 // - records requests
 // - returns empty responses
-func (suite *managementAPISuite) setUpDispatcher() *[]*X509Request {
-    fixedResponse := X509Response{
+func (suite *managementAPISuite) setUpDispatcher() *[]*x509Request {
+    fixedResponse := x509Response{
         StatusCode: http.StatusOK,
         Body:       []byte{},
     }
     rigFixedResponseDispatcher(&fixedResponse)
-    recordedRequests := make([]*X509Request, 0)
+    recordedRequests := make([]*x509Request, 0)
     rigRecordingDispatcher(&recordedRequests)
     return &recordedRequests
 }
 
 // checkRequest asserts that the given slice contains one request, with the
 // given characteristics.
-func checkRequest(c *C, recordedRequests *[]*X509Request, URL string, payload []byte, Method string) {
+func checkRequest(c *C, recordedRequests *[]*x509Request, URL string, payload []byte, Method string) {
     requests := *recordedRequests
     c.Assert(len(requests), Equals, 1)
     request := requests[0]
@@ -128,8 +128,8 @@
 
 func (suite *managementAPISuite) TestAddStorageAccount(c *C) {
     api := suite.makeAPI(c)
-    rigFixedResponseDispatcher(&X509Response{StatusCode: http.StatusAccepted})
-    recordedRequests := make([]*X509Request, 0)
+    rigFixedResponseDispatcher(&x509Response{StatusCode: http.StatusAccepted})
+    recordedRequests := make([]*x509Request, 0)
     rigRecordingDispatcher(&recordedRequests)
     cssi := NewCreateStorageServiceInputWithLocation("name", "label", "East US")
 

=== modified file 'x509dispatcher.go'
--- x509dispatcher.go	2013-03-22 02:52:32 +0000
+++ x509dispatcher.go	2013-03-26 08:56:20 +0000
@@ -10,7 +10,7 @@
     "net/textproto"
 )
 
-type X509Request struct {
+type x509Request struct {
     APIVersion  string
     Method      string
     URL         string
@@ -28,20 +28,20 @@
 // baseAPIVersion is the default Azure API version to use.
 const baseAPIVersion = "2012-03-01"
 
-// newX509RequestGET initializes an X509Request for a GET.  You may still need
+// newX509RequestGET initializes an x509Request for a GET.  You may still need
 // to set further values.
-func newX509RequestGET(url string) *X509Request {
-    return &X509Request{
+func newX509RequestGET(url string) *x509Request {
+    return &x509Request{
         Method:     "GET",
         URL:        url,
         APIVersion: baseAPIVersion,
     }
 }
 
-// newX509RequestPOST initializes an X509Request for a POST.  You may still
+// newX509RequestPOST initializes an x509Request for a POST.  You may still
 // need to set further values.
-func newX509RequestPOST(url string, payload []byte, contentType string) *X509Request {
-    return &X509Request{
+func newX509RequestPOST(url string, payload []byte, contentType string) *x509Request {
+    return &x509Request{
         Method:      "POST",
         URL:         url,
         APIVersion:  baseAPIVersion,
@@ -50,19 +50,19 @@
     }
 }
 
-// newX509RequestDELETE initializes an X509Request for a DELETE.
-func newX509RequestDELETE(url string) *X509Request {
-    return &X509Request{
+// newX509RequestDELETE initializes an x509Request for a DELETE.
+func newX509RequestDELETE(url string) *x509Request {
+    return &x509Request{
         Method:     "DELETE",
         URL:        url,
         APIVersion: baseAPIVersion,
     }
 }
 
-// newX509RequestPUT initializes an X509Request for a PUT.  You may still
+// newX509RequestPUT initializes an x509Request for a PUT.  You may still
 // need to set further values.
-func newX509RequestPUT(url string, payload []byte) *X509Request {
-    return &X509Request{
+func newX509RequestPUT(url string, payload []byte) *x509Request {
+    return &x509Request{
         Method:     "PUT",
         URL:        url,
         APIVersion: baseAPIVersion,
@@ -70,7 +70,7 @@
     }
 }
 
-type X509Response struct {
+type x509Response struct {
     StatusCode int
     // TODO: What exactly do we get back?  How will we know its encoding?
     Body      []byte
@@ -78,8 +78,8 @@
     Header    http.Header
 }
 
-func newX509Response() *X509Response {
-    return &X509Response{
+func newX509Response() *x509Response {
+    return &x509Response{
         Body:      make([]byte, 0),
         RawHeader: make([]byte, 0),
     }
@@ -120,7 +120,7 @@
 
 // parseHeader parses the raw header as stored in RawHeader, and uses it to
 // initialize Header.
-func (response *X509Response) parseHeader() error {
+func (response *x509Response) parseHeader() error {
     rawHeader := stripPreliminaryResponses(response.RawHeader)
     mimeHeader, err := stripResponseLine(rawHeader)
     if err != nil {
@@ -141,7 +141,7 @@
     return nil
 }
 
-func performX509CurlRequest(session *X509Session, request *X509Request) (*X509Response, error) {
+func performX509CurlRequest(session *x509Session, request *x509Request) (*x509Response, error) {
     if verbose {
         log.Println("Performing request")
         log.Println("Request url: " + request.URL)
@@ -181,7 +181,7 @@
 // makeCurlRequest produces a curl.CURL representing the request.
 // Clean up the request by calling its Cleanup() method after you're done
 // with it.
-func (request *X509Request) makeCurlRequest(session *X509Session, response *X509Response) *curl.CURL {
+func (request *x509Request) makeCurlRequest(session *x509Session, response *x509Response) *curl.CURL {
     ch := curl.EasyInit()
 
     ch.Setopt(curl.OPT_SSLCERT, session.certFile)
@@ -230,7 +230,7 @@
 
 // setCurlHTTPMethod sets up a CURL object to perform an HTTP request of
 // the HTTP method (GET, POST, etc.) appropriate for the request.
-func (request *X509Request) setCurlHTTPMethod(ch *curl.CURL) {
+func (request *x509Request) setCurlHTTPMethod(ch *curl.CURL) {
     switch request.Method {
     case "GET":
         // Nothing to be done.  This is the default.

=== modified file 'x509dispatcher_test.go'
--- x509dispatcher_test.go	2013-03-22 02:06:22 +0000
+++ x509dispatcher_test.go	2013-03-26 08:56:20 +0000
@@ -30,7 +30,7 @@
 // An HTTP header contains a response line followed by a MIME header, which
 // parseHeader processes.
 func (*X509DispatcherSuite) TestParseHeaderParsesHTTPHeader(c *C) {
-    response := X509Response{}
+    response := x509Response{}
     text := "HTTP/1.1 200 OK\r\nCache-Control: no-cache\r\n\r\n"
     response.RawHeader = []byte(text)
 
@@ -43,7 +43,7 @@
 // An HTTP response actually contains a sequence of HTTP headers, and
 // parseHeader only uses the final one.
 func (*X509DispatcherSuite) TestParseHeaderParsesContinueResponse(c *C) {
-    response := X509Response{}
+    response := x509Response{}
     text := "HTTP/1.1 100 Continue\r\n\r\nHTTP/1.1 202 Accepted\r\nCache-Control: no-cache\r\n\r\n"
     response.RawHeader = []byte(text)
 
@@ -58,7 +58,7 @@
     server := makeRecordingHTTPServer(httpRequests, http.StatusOK, nil)
     defer server.Close()
     // No real certificate needed since we're testing on http, not https.
-    session, err := NewX509Session("subscriptionid", "cert.pem")
+    session, err := newX509Session("subscriptionid", "cert.pem")
     c.Assert(err, IsNil)
     path := "/foo/bar"
     request := newX509RequestGET(server.URL + path)
@@ -80,7 +80,7 @@
     server := makeRecordingHTTPServer(httpRequests, http.StatusOK, responseBody)
     defer server.Close()
     // No real certificate needed since we're testing on http, not https.
-    session, err := NewX509Session("subscriptionid", "cert.pem")
+    session, err := newX509Session("subscriptionid", "cert.pem")
     c.Assert(err, IsNil)
     path := "/foo/bar"
     request := newX509RequestPOST(server.URL+path, requestBody, requestContentType)
@@ -102,7 +102,7 @@
     server := makeRecordingHTTPServer(httpRequests, http.StatusOK, []byte{})
     defer server.Close()
     // No real certificate needed since we're testing on http, not https.
-    session, err := NewX509Session("subscriptionid", "cert.pem")
+    session, err := newX509Session("subscriptionid", "cert.pem")
     c.Assert(err, IsNil)
     path := "/foo/bar"
     request := newX509RequestDELETE(server.URL + path)
@@ -123,7 +123,7 @@
     server := makeRecordingHTTPServer(httpRequests, http.StatusOK, responseBody)
     defer server.Close()
     // No real certificate needed since we're testing on http, not https.
-    session, err := NewX509Session("subscriptionid", "cert.pem")
+    session, err := newX509Session("subscriptionid", "cert.pem")
     c.Assert(err, IsNil)
     path := "/foo/bar"
     request := newX509RequestPUT(server.URL+path, requestBody)
@@ -149,7 +149,7 @@
     serveMux.HandleFunc("/", returnRequest)
     server := httptest.NewServer(serveMux)
     defer server.Close()
-    session, err := NewX509Session("subscriptionid", "cert.pem")
+    session, err := newX509Session("subscriptionid", "cert.pem")
     c.Assert(err, IsNil)
     path := "/foo/bar"
     request := newX509RequestGET(server.URL + path)

=== modified file 'x509session.go'
--- x509session.go	2013-03-20 23:53:03 +0000
+++ x509session.go	2013-03-26 08:56:20 +0000
@@ -8,15 +8,15 @@
     "net/http"
 )
 
-type X509Session struct {
+type x509Session struct {
     subscriptionId string
     certFile       string
 }
 
-// NewX509Session creates and returns a new X509Session based on credentials
+// newX509Session creates and returns a new x509Session based on credentials
 // and X509 certificate files.
-func NewX509Session(subscriptionId string, certFile string) (*X509Session, error) {
-    return &X509Session{subscriptionId: subscriptionId, certFile: certFile}, nil
+func newX509Session(subscriptionId string, certFile string) (*x509Session, error) {
+    return &x509Session{subscriptionId: subscriptionId, certFile: certFile}, nil
 }
 
 var AZURE_URL = "https://management.core.windows.net/"
@@ -43,7 +43,7 @@
 
 // getServerError returns a ServerError matching the given server response
 // status, or nil if the server response indicates success.
-func (session *X509Session) getServerError(status int, description string) error {
+func (session *x509Session) getServerError(status int, description string) error {
     if status < http.StatusOK || status >= http.StatusMultipleChoices {
         failure := fmt.Errorf("%s (http status code %d)", description, status)
         return &ServerError{error: failure, StatusCode: status}
@@ -55,7 +55,7 @@
 // It returns the response body and/or an error.  If the error is a
 // ServerError, the returned body will be the one received from the server.
 // For any other kind of error, the returned body will be nil.
-func (session *X509Session) get(url string) ([]byte, error) {
+func (session *x509Session) get(url string) ([]byte, error) {
     fullUrl := composeURL(url, session.subscriptionId)
     request := newX509RequestGET(fullUrl)
     response, err := _X509Dispatcher(session, request)
@@ -70,7 +70,7 @@
 // It returns the response body and/or an error.  If the error is a
 // ServerError, the returned body will be the one received from the server.
 // For any other kind of error, the returned body will be nil.
-func (session *X509Session) post(url string, body []byte, contentType string) ([]byte, error) {
+func (session *x509Session) post(url string, body []byte, contentType string) ([]byte, error) {
     fullUrl := composeURL(url, session.subscriptionId)
     request := newX509RequestPOST(fullUrl, body, contentType)
     response, err := _X509Dispatcher(session, request)
@@ -82,7 +82,7 @@
 }
 
 // delete performs a DELETE request to the Azure management API.
-func (session *X509Session) delete(url string) error {
+func (session *x509Session) delete(url string) error {
     fullUrl := composeURL(url, session.subscriptionId)
     request := newX509RequestDELETE(fullUrl)
     response, err := _X509Dispatcher(session, request)
@@ -93,7 +93,7 @@
 }
 
 // put performs a PUT request to the Azure management API.
-func (session *X509Session) put(url string, body []byte) error {
+func (session *x509Session) put(url string, body []byte) error {
     fullUrl := composeURL(url, session.subscriptionId)
     request := newX509RequestPUT(fullUrl, body)
     response, err := _X509Dispatcher(session, request)

=== modified file 'x509session_test.go'
--- x509session_test.go	2013-03-20 23:53:03 +0000
+++ x509session_test.go	2013-03-26 08:56:20 +0000
@@ -18,7 +18,7 @@
 )
 
 type X509SessionSuite struct {
-    oldDispatcher func(*X509Session, *X509Request) (*X509Response, error)
+    oldDispatcher func(*x509Session, *x509Request) (*x509Response, error)
 }
 
 var _ = Suite(&X509SessionSuite{})
@@ -29,9 +29,9 @@
 // If you also want the dispatcher to return a particular result, rig it for
 // that result first (using one of the other rig...Dispatcher functions) and
 // then chain the recording dispatcher in front of it.
-func rigRecordingDispatcher(record *[]*X509Request) {
+func rigRecordingDispatcher(record *[]*x509Request) {
     previousDispatcher := _X509Dispatcher
-    _X509Dispatcher = func(session *X509Session, request *X509Request) (*X509Response, error) {
+    _X509Dispatcher = func(session *x509Session, request *x509Request) (*x509Response, error) {
         *record = append(*record, request)
         return previousDispatcher(session, request)
     }
@@ -39,8 +39,8 @@
 
 // rigFixedResponseDispatcher sets up a request dispatcher that always returns
 // a prepared response.
-func rigFixedResponseDispatcher(response *X509Response) {
-    _X509Dispatcher = func(*X509Session, *X509Request) (*X509Response, error) {
+func rigFixedResponseDispatcher(response *x509Response) {
+    _X509Dispatcher = func(*x509Session, *x509Request) (*x509Response, error) {
         return response, nil
     }
 }
@@ -48,7 +48,7 @@
 // rigFailingDispatcher sets up a request dispatcher that returns a given
 // error.
 func rigFailingDispatcher(failure error) {
-    _X509Dispatcher = func(*X509Session, *X509Request) (*X509Response, error) {
+    _X509Dispatcher = func(*x509Session, *x509Request) (*x509Response, error) {
         return nil, failure
     }
 }
@@ -125,14 +125,14 @@
 }
 
 func (suite *X509SessionSuite) TestNewX509SessionCreation(c *C) {
-    _, err := NewX509Session("subscriptionid", "azure.pem")
+    _, err := newX509Session("subscriptionid", "azure.pem")
     c.Assert(err, IsNil)
 }
 
 func (suite *X509SessionSuite) TestGetServerErrorProducesServerError(c *C) {
     msg := "huhwhat"
     status := http.StatusNotFound
-    session, err := NewX509Session("subscriptionid", "azure.pem")
+    session, err := newX509Session("subscriptionid", "azure.pem")
     c.Assert(err, IsNil)
 
     err = session.getServerError(status, msg)
@@ -148,7 +148,7 @@
         http.StatusOK,
         http.StatusNoContent,
     }
-    session, err := NewX509Session("subscriptionid", "azure.pem")
+    session, err := newX509Session("subscriptionid", "azure.pem")
     c.Assert(err, IsNil)
 
     for _, status := range goodCodes {
@@ -166,7 +166,7 @@
         http.StatusInternalServerError,
         http.StatusNotImplemented,
     }
-    session, err := NewX509Session("subscriptionid", "azure.pem")
+    session, err := newX509Session("subscriptionid", "azure.pem")
     c.Assert(err, IsNil)
 
     for _, status := range badCodes {
@@ -177,15 +177,15 @@
 func (suite *X509SessionSuite) TestGetIssuesRequest(c *C) {
     subscriptionID := "subscriptionID"
     uri := "resource"
-    session, err := NewX509Session(subscriptionID, "cert.pem")
+    session, err := newX509Session(subscriptionID, "cert.pem")
     c.Assert(err, IsNil)
     // Record incoming requests, and have them return a given reply.
-    fixedResponse := X509Response{
+    fixedResponse := x509Response{
         StatusCode: http.StatusOK,
         Body:       []byte("Response body"),
     }
     rigFixedResponseDispatcher(&fixedResponse)
-    recordedRequests := make([]*X509Request, 0)
+    recordedRequests := make([]*x509Request, 0)
     rigRecordingDispatcher(&recordedRequests)
 
     receivedBody, err := session.get(uri)
@@ -199,7 +199,7 @@
 }
 
 func (suite *X509SessionSuite) TestGetReportsClientSideError(c *C) {
-    session, err := NewX509Session("subscriptionid", "cert.pem")
+    session, err := newX509Session("subscriptionid", "cert.pem")
     msg := "could not dispatch request"
     rigFailingDispatcher(fmt.Errorf(msg))
 
@@ -211,8 +211,8 @@
 }
 
 func (suite *X509SessionSuite) TestGetReportsServerSideError(c *C) {
-    session, err := NewX509Session("subscriptionid", "cert.pem")
-    fixedResponse := X509Response{
+    session, err := newX509Session("subscriptionid", "cert.pem")
+    fixedResponse := x509Response{
         StatusCode: http.StatusForbidden,
         Body:       []byte("Body"),
     }
@@ -231,15 +231,15 @@
     uri := "resource"
     requestBody := []byte("Request body")
     requestContentType := "bogusContentType"
-    session, err := NewX509Session(subscriptionID, "cert.pem")
+    session, err := newX509Session(subscriptionID, "cert.pem")
     c.Assert(err, IsNil)
     // Record incoming requests, and have them return a given reply.
-    fixedResponse := X509Response{
+    fixedResponse := x509Response{
         StatusCode: http.StatusOK,
         Body:       []byte("Response body"),
     }
     rigFixedResponseDispatcher(&fixedResponse)
-    recordedRequests := make([]*X509Request, 0)
+    recordedRequests := make([]*x509Request, 0)
     rigRecordingDispatcher(&recordedRequests)
 
     receivedBody, err := session.post(uri, requestBody, requestContentType)
@@ -255,7 +255,7 @@
 }
 
 func (suite *X509SessionSuite) TestPostReportsClientSideError(c *C) {
-    session, err := NewX509Session("subscriptionid", "cert.pem")
+    session, err := newX509Session("subscriptionid", "cert.pem")
     msg := "could not dispatch request"
     rigFailingDispatcher(fmt.Errorf(msg))
 
@@ -267,8 +267,8 @@
 }
 
 func (suite *X509SessionSuite) TestPostReportsServerSideError(c *C) {
-    session, err := NewX509Session("subscriptionid", "cert.pem")
-    fixedResponse := X509Response{
+    session, err := newX509Session("subscriptionid", "cert.pem")
+    fixedResponse := x509Response{
         StatusCode: http.StatusForbidden,
         Body:       []byte("Body"),
     }
@@ -285,12 +285,12 @@
 func (suite *X509SessionSuite) TestDeleteIssuesRequest(c *C) {
     subscriptionID := "subscriptionID"
     uri := "resource"
-    session, err := NewX509Session(subscriptionID, "cert.pem")
+    session, err := newX509Session(subscriptionID, "cert.pem")
     c.Assert(err, IsNil)
     // Record incoming requests, and have them return a given reply.
-    fixedResponse := X509Response{StatusCode: http.StatusOK}
+    fixedResponse := x509Response{StatusCode: http.StatusOK}
     rigFixedResponseDispatcher(&fixedResponse)
-    recordedRequests := make([]*X509Request, 0)
+    recordedRequests := make([]*x509Request, 0)
     rigRecordingDispatcher(&recordedRequests)
 
     err = session.delete(uri)
@@ -306,14 +306,14 @@
     subscriptionID := "subscriptionID"
     uri := "resource"
     requestBody := []byte("Request body")
-    session, err := NewX509Session(subscriptionID, "cert.pem")
+    session, err := newX509Session(subscriptionID, "cert.pem")
     c.Assert(err, IsNil)
     // Record incoming requests, and have them return a given reply.
-    fixedResponse := X509Response{
+    fixedResponse := x509Response{
         StatusCode: http.StatusOK,
     }
     rigFixedResponseDispatcher(&fixedResponse)
-    recordedRequests := make([]*X509Request, 0)
+    recordedRequests := make([]*x509Request, 0)
     rigRecordingDispatcher(&recordedRequests)
 
     err = session.put(uri, requestBody)