~jtv/gwacl/storage-tool-command-line

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// Copyright 2013 Canonical Ltd.  This software is licensed under the
// GNU Lesser General Public License version 3 (see the file COPYING).

package gwacl

import (
    "encoding/xml"
    "fmt"
    . "launchpad.net/gocheck"
    "launchpad.net/gwacl/dedent"
    "net/http"
    "time"
)

type pollerSuite struct{}

var _ = Suite(&pollerSuite{})

func (suite *pollerSuite) makeAPI(c *C) *ManagementAPI {
    subscriptionId := "subscriptionId"
    subscriptionId = subscriptionId
    api, err := NewManagementAPI(subscriptionId, "", "West US")
    c.Assert(err, IsNil)
    return api
}

// testPoller is a struct which implements the Poller interface.  It records
// the number of calls to testPoller.Poll().
type testPoller struct {
    recordedPollCalls int
    notDoneCalls      int
    errorCalls        int
}

var testPollerResponse = x509Response{}
var testPollerError = fmt.Errorf("Test error")

// newTestPoller return a pointer to a testPoller object that will return
// false when IsDone() will be called 'notDoneCalls' number of times and that
// will error when Poll() will be called 'errorCalls' number of times.
func newTestPoller(notDoneCalls int, errorCalls int) *testPoller {
    return &testPoller{0, notDoneCalls, errorCalls}
}

func (poller *testPoller) poll() (*x509Response, error) {
    if poller.errorCalls > 0 {
        poller.errorCalls -= 1
        return nil, testPollerError
    }
    poller.recordedPollCalls += 1
    return &testPollerResponse, nil
}

func (poller *testPoller) isDone(response *x509Response, pollerError error) (bool, error) {
    if pollerError != nil {
        return true, pollerError
    }
    if poller.notDoneCalls == 0 {
        return true, nil
    }
    poller.notDoneCalls = poller.notDoneCalls - 1
    return false, nil
}

func (suite *pollerSuite) TestperformPollingPollsOnceImmediately(c *C) {
    poller := newTestPoller(0, 0)
    interval := time.Second * 10
    start := time.Now()
    response, err := performPolling(poller, interval, interval*2)
    c.Assert(err, Equals, nil)
    c.Assert(time.Since(start) < interval, Equals, true)
    c.Assert(response, DeepEquals, &testPollerResponse)
}

func (suite *pollerSuite) TestperformPollingReturnsError(c *C) {
    poller := newTestPoller(0, 1)
    response, err := performPolling(poller, time.Nanosecond, time.Minute)

    c.Assert(err, Equals, testPollerError)
    c.Assert(response, IsNil)
}

func (suite *pollerSuite) TestperformPollingTimesout(c *C) {
    poller := newTestPoller(10, 0)
    response, err := performPolling(poller, time.Millisecond, 5*time.Millisecond)

    c.Assert(response, IsNil)
    c.Check(err, ErrorMatches, ".*polling timed out waiting for an asynchronous operation.*")
}

func (suite *pollerSuite) TestperformPollingRetries(c *C) {
    poller := newTestPoller(2, 0)
    response, err := performPolling(poller, time.Nanosecond, time.Minute)

    c.Assert(err, IsNil)
    c.Assert(response, DeepEquals, &testPollerResponse)
    // Poll() has been called 3 times: two calls for which IsDone() returned
    // false and one for which IsDone() return true.
    c.Assert(poller.recordedPollCalls, Equals, 3)
}

func (suite *pollerSuite) TestnewOperationPoller(c *C) {
    api := suite.makeAPI(c)
    operationID := "operationID"

    poller := newOperationPoller(api, operationID)

    operationPollerInstance := poller.(operationPoller)
    c.Check(operationPollerInstance.api, Equals, api)
    c.Check(operationPollerInstance.operationID, Equals, operationID)
}

func (suite *pollerSuite) TestOperationPollerPoll(c *C) {
    api := suite.makeAPI(c)
    operationID := "operationID"
    poller := newOperationPoller(api, operationID)
    recordedRequests := setUpDispatcher("operationID")

    _, err := poller.poll()

    c.Assert(err, IsNil)
    expectedURL := defaultManagement + api.session.subscriptionId + "/operations/" + operationID
    checkOneRequest(c, recordedRequests, expectedURL, "2009-10-01", nil, "GET")
}

var operationXMLTemplate = dedent.Dedent(`
<?xml version="1.0" encoding="utf-8"?>
  <Operation xmlns="http://schemas.microsoft.com/windowsazure">
    <ID>bogus-request-id</ID>
    <Status>%s</Status>
  </Operation>
`)

func (suite *pollerSuite) TestOperationPollerIsDoneReturnsTrueIfOperationDone(c *C) {
    poller := newOperationPoller(suite.makeAPI(c), "operationID")
    operationStatuses := []string{"Succeeded", "Failed"}
    for _, operationStatus := range operationStatuses {
        body := fmt.Sprintf(operationXMLTemplate, operationStatus)
        response := x509Response{
            Body:       []byte(body),
            StatusCode: http.StatusOK,
        }

        isDone, err := poller.isDone(&response, nil)
        c.Assert(err, IsNil)
        c.Assert(isDone, Equals, true)
    }
}

func (suite *pollerSuite) TestOperationPollerIsDoneReturnsFalse(c *C) {
    poller := newOperationPoller(suite.makeAPI(c), "operationID")
    notDoneResponses := []x509Response{
        // 'InProgress' response.
        {
            Body:       []byte(fmt.Sprintf(operationXMLTemplate, "InProgress")),
            StatusCode: http.StatusOK,
        },
        // Error statuses.
        {StatusCode: http.StatusNotFound},
        {StatusCode: http.StatusBadRequest},
        {StatusCode: http.StatusInternalServerError},
    }
    for _, response := range notDoneResponses {
        isDone, _ := poller.isDone(&response, nil)
        c.Assert(isDone, Equals, false)
    }
}

func (suite *pollerSuite) TestOperationPollerIsDoneReturnsXMLParsingError(c *C) {
    poller := newOperationPoller(suite.makeAPI(c), "operationID")
    // Invalid XML content.
    response := x509Response{
        Body:       []byte("><invalid XML"),
        StatusCode: http.StatusOK,
    }
    _, err := poller.isDone(&response, nil)
    c.Assert(err, NotNil)
    c.Check(err, FitsTypeOf, new(xml.SyntaxError))
}

func (suite *pollerSuite) TestStartOperationPollingRetries(c *C) {
    // This is an end-to-end test of the operation poller; there is a certain
    // amount of duplication with the unit tests for performPolling() but
    // it's probably worth it to thoroughly test performOperationPolling().

    // Fake 2 responses in sequence: a 'InProgress' response and then a
    // 'Succeeded' response.
    firstResponse := DispatcherResponse{
        response: &x509Response{
            Body:       []byte(fmt.Sprintf(operationXMLTemplate, "InProgress")),
            StatusCode: http.StatusOK,
        },
        errorObject: nil}
    secondResponse := DispatcherResponse{
        response: &x509Response{
            Body:       []byte(fmt.Sprintf(operationXMLTemplate, "Succeeded")),
            StatusCode: http.StatusOK,
        },
        errorObject: nil}
    responses := []DispatcherResponse{firstResponse, secondResponse}
    rigPreparedResponseDispatcher(responses)
    recordedRequests := make([]*X509Request, 0)
    rigRecordingDispatcher(&recordedRequests)

    // Setup poller and start it.
    operationID := "operationID"
    poller := newOperationPoller(suite.makeAPI(c), operationID)
    response, err := performPolling(poller, time.Nanosecond, time.Minute)

    c.Assert(err, IsNil)
    c.Assert(response, DeepEquals, secondResponse.response)
    operationPollerInstance := poller.(operationPoller)
    expectedURL := defaultManagement + operationPollerInstance.api.session.subscriptionId + "/operations/" + operationID
    c.Assert(len(recordedRequests), Equals, 2)
    checkRequest(c, recordedRequests[0], expectedURL, "2009-10-01", nil, "GET")
    checkRequest(c, recordedRequests[1], expectedURL, "2009-10-01", nil, "GET")
}