From bdc268bca3d9141374be869c6c89787089c47d01 Mon Sep 17 00:00:00 2001 From: Ahmet Alp Balkan Date: Wed, 4 Feb 2015 16:37:43 -0800 Subject: [PATCH] Vendor azure-sdk-for-go with godep Signed-off-by: Ahmet Alp Balkan --- Godeps/Godeps.json | 5 + .../azure-sdk-for-go/clients/storage/blob.go | 884 +++++++++++++ .../clients/storage/blob_test.go | 1123 +++++++++++++++++ .../clients/storage/client.go | 315 +++++ .../clients/storage/client_test.go | 203 +++ .../azure-sdk-for-go/clients/storage/util.go | 63 + .../clients/storage/util_test.go | 80 ++ 7 files changed, 2673 insertions(+) create mode 100644 Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob.go create mode 100644 Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob_test.go create mode 100644 Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client.go create mode 100644 Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client_test.go create mode 100644 Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util.go create mode 100644 Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util_test.go diff --git a/Godeps/Godeps.json b/Godeps/Godeps.json index 41b729ea..9d41e0f2 100644 --- a/Godeps/Godeps.json +++ b/Godeps/Godeps.json @@ -22,6 +22,11 @@ "ImportPath": "github.com/AdRoll/goamz/s3", "Rev": "d3664b76d90508cdda5a6c92042f26eab5db3103" }, + { + "ImportPath": "github.com/MSOpenTech/azure-sdk-for-go/clients/storage", + "Comment": "v1.1-119-g0fbd371", + "Rev": "0fbd37144de3adc2aef74db867c0e15e41c7f74a" + }, { "ImportPath": "github.com/Sirupsen/logrus", "Comment": "v0.6.1-8-gcc09837", diff --git a/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob.go b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob.go new file mode 100644 index 00000000..f451e51f --- /dev/null +++ b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob.go @@ -0,0 +1,884 @@ +package storage + +import ( + "bytes" + "encoding/base64" + "encoding/xml" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "strconv" + "strings" + "time" +) + +type BlobStorageClient struct { + client StorageClient +} + +// A Container is an entry in ContainerListResponse. +type Container struct { + Name string `xml:"Name"` + Properties ContainerProperties `xml:"Properties"` + // TODO (ahmetalpbalkan) Metadata +} + +// ContainerProperties contains various properties of a +// container returned from various endpoints like ListContainers. +type ContainerProperties struct { + LastModified string `xml:"Last-Modified"` + Etag string `xml:"Etag"` + LeaseStatus string `xml:"LeaseStatus"` + LeaseState string `xml:"LeaseState"` + LeaseDuration string `xml:"LeaseDuration"` + // TODO (ahmetalpbalkan) remaining fields +} + +// ContainerListResponse contains the response fields from +// ListContainers call. https://msdn.microsoft.com/en-us/library/azure/dd179352.aspx +type ContainerListResponse struct { + XMLName xml.Name `xml:"EnumerationResults"` + Xmlns string `xml:"xmlns,attr"` + Prefix string `xml:"Prefix"` + Marker string `xml:"Marker"` + NextMarker string `xml:"NextMarker"` + MaxResults int64 `xml:"MaxResults"` + Containers []Container `xml:"Containers>Container"` +} + +// A Blob is an entry in BlobListResponse. +type Blob struct { + Name string `xml:"Name"` + Properties BlobProperties `xml:"Properties"` + // TODO (ahmetalpbalkan) Metadata +} + +// BlobProperties contains various properties of a blob +// returned in various endpoints like ListBlobs or GetBlobProperties. +type BlobProperties struct { + LastModified string `xml:"Last-Modified"` + Etag string `xml:"Etag"` + ContentMD5 string `xml:"Content-MD5"` + ContentLength int64 `xml:"Content-Length"` + ContentType string `xml:"Content-Type"` + ContentEncoding string `xml:"Content-Encoding"` + BlobType BlobType `xml:"x-ms-blob-blob-type"` + SequenceNumber int64 `xml:"x-ms-blob-sequence-number"` + CopyId string `xml:"CopyId"` + CopyStatus string `xml:"CopyStatus"` + CopySource string `xml:"CopySource"` + CopyProgress string `xml:"CopyProgress"` + CopyCompletionTime string `xml:"CopyCompletionTime"` + CopyStatusDescription string `xml:"CopyStatusDescription"` +} + +// BlobListResponse contains the response fields from +// ListBlobs call. https://msdn.microsoft.com/en-us/library/azure/dd135734.aspx +type BlobListResponse struct { + XMLName xml.Name `xml:"EnumerationResults"` + Xmlns string `xml:"xmlns,attr"` + Prefix string `xml:"Prefix"` + Marker string `xml:"Marker"` + NextMarker string `xml:"NextMarker"` + MaxResults int64 `xml:"MaxResults"` + Blobs []Blob `xml:"Blobs>Blob"` +} + +// ListContainersParameters defines the set of customizable +// parameters to make a List Containers call. https://msdn.microsoft.com/en-us/library/azure/dd179352.aspx +type ListContainersParameters struct { + Prefix string + Marker string + Include string + MaxResults uint + Timeout uint +} + +func (p ListContainersParameters) getParameters() url.Values { + out := url.Values{} + + if p.Prefix != "" { + out.Set("prefix", p.Prefix) + } + if p.Marker != "" { + out.Set("marker", p.Marker) + } + if p.Include != "" { + out.Set("include", p.Include) + } + if p.MaxResults != 0 { + out.Set("maxresults", fmt.Sprintf("%v", p.MaxResults)) + } + if p.Timeout != 0 { + out.Set("timeout", fmt.Sprintf("%v", p.Timeout)) + } + + return out +} + +// ListBlobsParameters defines the set of customizable +// parameters to make a List Blobs call. https://msdn.microsoft.com/en-us/library/azure/dd135734.aspx +type ListBlobsParameters struct { + Prefix string + Delimiter string + Marker string + Include string + MaxResults uint + Timeout uint +} + +func (p ListBlobsParameters) getParameters() url.Values { + out := url.Values{} + + if p.Prefix != "" { + out.Set("prefix", p.Prefix) + } + if p.Delimiter != "" { + out.Set("delimiter", p.Delimiter) + } + if p.Marker != "" { + out.Set("marker", p.Marker) + } + if p.Include != "" { + out.Set("include", p.Include) + } + if p.MaxResults != 0 { + out.Set("maxresults", fmt.Sprintf("%v", p.MaxResults)) + } + if p.Timeout != 0 { + out.Set("timeout", fmt.Sprintf("%v", p.Timeout)) + } + + return out +} + +// BlobType defines the type of the Azure Blob. +type BlobType string + +const ( + BlobTypeBlock BlobType = "BlockBlob" + BlobTypePage BlobType = "PageBlob" +) + +// PageWriteType defines the type updates that are going to be +// done on the page blob. +type PageWriteType string + +const ( + PageWriteTypeUpdate PageWriteType = "update" + PageWriteTypeClear PageWriteType = "clear" +) + +const ( + blobCopyStatusPending = "pending" + blobCopyStatusSuccess = "success" + blobCopyStatusAborted = "aborted" + blobCopyStatusFailed = "failed" +) + +// BlockListType is used to filter out types of blocks +// in a Get Blocks List call for a block blob. See +// https://msdn.microsoft.com/en-us/library/azure/dd179400.aspx +// for all block types. +type BlockListType string + +const ( + BlockListTypeAll BlockListType = "all" + BlockListTypeCommitted BlockListType = "committed" + BlockListTypeUncommitted BlockListType = "uncommitted" +) + +// ContainerAccessType defines the access level to the container +// from a public request. See https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx +// and "x-ms-blob-public-access" header. +type ContainerAccessType string + +const ( + ContainerAccessTypePrivate ContainerAccessType = "" + ContainerAccessTypeBlob ContainerAccessType = "blob" + ContainerAccessTypeContainer ContainerAccessType = "container" +) + +const ( + MaxBlobBlockSize = 4 * 1024 * 1024 + MaxBlobPageSize = 4 * 1024 * 1024 +) + +// BlockStatus defines states a block for a block blob can +// be in. +type BlockStatus string + +const ( + BlockStatusUncommitted BlockStatus = "Uncommitted" + BlockStatusCommitted BlockStatus = "Committed" + BlockStatusLatest BlockStatus = "Latest" +) + +// Block is used to create Block entities for Put Block List +// call. +type Block struct { + Id string + Status BlockStatus +} + +// BlockListResponse contains the response fields from +// Get Block List call. https://msdn.microsoft.com/en-us/library/azure/dd179400.aspx +type BlockListResponse struct { + XMLName xml.Name `xml:"BlockList"` + CommittedBlocks []BlockResponse `xml:"CommittedBlocks>Block"` + UncommittedBlocks []BlockResponse `xml:"UncommittedBlocks>Block"` +} + +// BlockResponse contains the block information returned +// in the GetBlockListCall. +type BlockResponse struct { + Name string `xml:"Name"` + Size int64 `xml:"Size"` +} + +// GetPageRangesResponse contains the reponse fields from +// Get Page Ranges call. https://msdn.microsoft.com/en-us/library/azure/ee691973.aspx +type GetPageRangesResponse struct { + XMLName xml.Name `xml:"PageList"` + PageList []PageRange `xml:"PageRange"` +} + +// PageRange contains information about a page of a page blob from +// Get Pages Range call. https://msdn.microsoft.com/en-us/library/azure/ee691973.aspx +type PageRange struct { + Start int64 `xml:"Start"` + End int64 `xml:"End"` +} + +var ( + ErrNotCreated = errors.New("storage: operation has returned a successful error code other than 201 Created.") + ErrNotAccepted = errors.New("storage: operation has returned a successful error code other than 202 Accepted.") + + errBlobCopyAborted = errors.New("storage: blob copy is aborted") + errBlobCopyIdMismatch = errors.New("storage: blob copy id is a mismatch") +) + +const errUnexpectedStatus = "storage: was expecting status code: %d, got: %d" + +// ListContainers returns the list of containers in a storage account along with +// pagination token and other response details. See https://msdn.microsoft.com/en-us/library/azure/dd179352.aspx +func (b BlobStorageClient) ListContainers(params ListContainersParameters) (ContainerListResponse, error) { + q := mergeParams(params.getParameters(), url.Values{"comp": {"list"}}) + uri := b.client.getEndpoint(blobServiceName, "", q) + headers := b.client.getStandardHeaders() + + var out ContainerListResponse + resp, err := b.client.exec("GET", uri, headers, nil) + if err != nil { + return out, err + } + + err = xmlUnmarshal(resp.body, &out) + return out, err +} + +// CreateContainer creates a blob container within the storage account +// with given name and access level. See https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx +// Returns error if container already exists. +func (b BlobStorageClient) CreateContainer(name string, access ContainerAccessType) error { + resp, err := b.createContainer(name, access) + if err != nil { + return err + } + if resp.statusCode != http.StatusCreated { + return ErrNotCreated + } + return nil +} + +// CreateContainerIfNotExists creates a blob container if it does not exist. Returns +// true if container is newly created or false if container already exists. +func (b BlobStorageClient) CreateContainerIfNotExists(name string, access ContainerAccessType) (bool, error) { + resp, err := b.createContainer(name, access) + if resp != nil && (resp.statusCode == http.StatusCreated || resp.statusCode == http.StatusConflict) { + return resp.statusCode == http.StatusCreated, nil + } + return false, err +} + +func (b BlobStorageClient) createContainer(name string, access ContainerAccessType) (*storageResponse, error) { + verb := "PUT" + uri := b.client.getEndpoint(blobServiceName, pathForContainer(name), url.Values{"restype": {"container"}}) + + headers := b.client.getStandardHeaders() + headers["Content-Length"] = "0" + if access != "" { + headers["x-ms-blob-public-access"] = string(access) + } + return b.client.exec(verb, uri, headers, nil) +} + +// ContainerExists returns true if a container with given name exists +// on the storage account, otherwise returns false. +func (b BlobStorageClient) ContainerExists(name string) (bool, error) { + verb := "HEAD" + uri := b.client.getEndpoint(blobServiceName, pathForContainer(name), url.Values{"restype": {"container"}}) + headers := b.client.getStandardHeaders() + + resp, err := b.client.exec(verb, uri, headers, nil) + if resp != nil && (resp.statusCode == http.StatusOK || resp.statusCode == http.StatusNotFound) { + return resp.statusCode == http.StatusOK, nil + } + return false, err +} + +// DeleteContainer deletes the container with given name on the storage +// account. See https://msdn.microsoft.com/en-us/library/azure/dd179408.aspx +// If the container does not exist returns error. +func (b BlobStorageClient) DeleteContainer(name string) error { + resp, err := b.deleteContainer(name) + if err != nil { + return err + } + if resp.statusCode != http.StatusAccepted { + return ErrNotAccepted + } + return nil +} + +// DeleteContainer deletes the container with given name on the storage +// account if it exists. See https://msdn.microsoft.com/en-us/library/azure/dd179408.aspx +// Returns true if container is deleted with this call, or false +// if the container did not exist at the time of the Delete Container operation. +func (b BlobStorageClient) DeleteContainerIfExists(name string) (bool, error) { + resp, err := b.deleteContainer(name) + if resp != nil && (resp.statusCode == http.StatusAccepted || resp.statusCode == http.StatusNotFound) { + return resp.statusCode == http.StatusAccepted, nil + } + return false, err +} + +func (b BlobStorageClient) deleteContainer(name string) (*storageResponse, error) { + verb := "DELETE" + uri := b.client.getEndpoint(blobServiceName, pathForContainer(name), url.Values{"restype": {"container"}}) + + headers := b.client.getStandardHeaders() + return b.client.exec(verb, uri, headers, nil) +} + +// ListBlobs returns an object that contains list of blobs in the container, +// pagination token and other information in the response of List Blobs call. +// See https://msdn.microsoft.com/en-us/library/azure/dd135734.aspx +func (b BlobStorageClient) ListBlobs(container string, params ListBlobsParameters) (BlobListResponse, error) { + q := mergeParams(params.getParameters(), url.Values{ + "restype": {"container"}, + "comp": {"list"}}) + uri := b.client.getEndpoint(blobServiceName, pathForContainer(container), q) + headers := b.client.getStandardHeaders() + + var out BlobListResponse + resp, err := b.client.exec("GET", uri, headers, nil) + if err != nil { + return out, err + } + + err = xmlUnmarshal(resp.body, &out) + return out, err +} + +// BlobExists returns true if a blob with given name exists on the +// specified container of the storage account. +func (b BlobStorageClient) BlobExists(container, name string) (bool, error) { + verb := "HEAD" + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{}) + + headers := b.client.getStandardHeaders() + resp, err := b.client.exec(verb, uri, headers, nil) + if resp != nil && (resp.statusCode == http.StatusOK || resp.statusCode == http.StatusNotFound) { + return resp.statusCode == http.StatusOK, nil + } + return false, err +} + +// GetBlobUrl gets the canonical URL to the blob with the specified +// name in the specified container. This method does not create a +// publicly accessible URL if the blob or container is private and this +// method does not check if the blob exists. +func (b BlobStorageClient) GetBlobUrl(container, name string) string { + if container == "" { + container = "$root" + } + return b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{}) +} + +// GetBlob downloads a blob to a stream. See https://msdn.microsoft.com/en-us/library/azure/dd179440.aspx +func (b BlobStorageClient) GetBlob(container, name string) (io.ReadCloser, error) { + resp, err := b.getBlobRange(container, name, "") + if err != nil { + return nil, err + } + + if resp.statusCode != http.StatusOK { + return nil, fmt.Errorf(errUnexpectedStatus, http.StatusOK, resp.statusCode) + } + return resp.body, nil +} + +// GetBlobRange reads the specified range of a blob to a stream. +// The bytesRange string must be in a format like "0-", "10-100" +// as defined in HTTP 1.1 spec. See https://msdn.microsoft.com/en-us/library/azure/dd179440.aspx +func (b BlobStorageClient) GetBlobRange(container, name, bytesRange string) (io.ReadCloser, error) { + resp, err := b.getBlobRange(container, name, bytesRange) + if err != nil { + return nil, err + } + + if resp.statusCode != http.StatusPartialContent { + return nil, fmt.Errorf(errUnexpectedStatus, http.StatusPartialContent, resp.statusCode) + } + return resp.body, nil +} + +func (b BlobStorageClient) getBlobRange(container, name, bytesRange string) (*storageResponse, error) { + verb := "GET" + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{}) + + headers := b.client.getStandardHeaders() + if bytesRange != "" { + headers["Range"] = fmt.Sprintf("bytes=%s", bytesRange) + } + resp, err := b.client.exec(verb, uri, headers, nil) + if err != nil { + return nil, err + } + return resp, err +} + +// GetBlobProperties provides various information about the specified +// blob. See https://msdn.microsoft.com/en-us/library/azure/dd179394.aspx +func (b BlobStorageClient) GetBlobProperties(container, name string) (*BlobProperties, error) { + verb := "HEAD" + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{}) + + headers := b.client.getStandardHeaders() + resp, err := b.client.exec(verb, uri, headers, nil) + if err != nil { + return nil, err + } + + if resp.statusCode != http.StatusOK { + return nil, fmt.Errorf(errUnexpectedStatus, http.StatusOK, resp.statusCode) + } + + var contentLength int64 + contentLengthStr := resp.headers.Get("Content-Length") + if contentLengthStr != "" { + contentLength, err = strconv.ParseInt(contentLengthStr, 0, 64) + if err != nil { + return nil, err + } + } + + var sequenceNum int64 + sequenceNumStr := resp.headers.Get("x-ms-blob-sequence-number") + if sequenceNumStr != "" { + sequenceNum, err = strconv.ParseInt(sequenceNumStr, 0, 64) + if err != nil { + return nil, err + } + } + + return &BlobProperties{ + LastModified: resp.headers.Get("Last-Modified"), + Etag: resp.headers.Get("Etag"), + ContentMD5: resp.headers.Get("Content-MD5"), + ContentLength: contentLength, + ContentEncoding: resp.headers.Get("Content-Encoding"), + SequenceNumber: sequenceNum, + CopyCompletionTime: resp.headers.Get("x-ms-copy-completion-time"), + CopyStatusDescription: resp.headers.Get("x-ms-copy-status-description"), + CopyId: resp.headers.Get("x-ms-copy-id"), + CopyProgress: resp.headers.Get("x-ms-copy-progress"), + CopySource: resp.headers.Get("x-ms-copy-source"), + CopyStatus: resp.headers.Get("x-ms-copy-status"), + BlobType: BlobType(resp.headers.Get("x-ms-blob-type")), + }, nil +} + +// CreateBlockBlob initializes an empty block blob with no blocks. +// See https://msdn.microsoft.com/en-us/library/azure/dd179451.aspx +func (b BlobStorageClient) CreateBlockBlob(container, name string) error { + path := fmt.Sprintf("%s/%s", container, name) + uri := b.client.getEndpoint(blobServiceName, path, url.Values{}) + headers := b.client.getStandardHeaders() + headers["x-ms-blob-type"] = string(BlobTypeBlock) + headers["Content-Length"] = fmt.Sprintf("%v", 0) + + resp, err := b.client.exec("PUT", uri, headers, nil) + if err != nil { + return err + } + if resp.statusCode != http.StatusCreated { + return ErrNotCreated + } + return nil +} + +// PutBlockBlob uploads given stream into a block blob by splitting +// data stream into chunks and uploading as blocks. Commits the block +// list at the end. This is a helper method built on top of PutBlock +// and PutBlockList methods with sequential block ID counting logic. +func (b BlobStorageClient) PutBlockBlob(container, name string, blob io.Reader) error { // TODO (ahmetalpbalkan) consider ReadCloser and closing + return b.putBlockBlob(container, name, blob, MaxBlobBlockSize) +} + +func (b BlobStorageClient) putBlockBlob(container, name string, blob io.Reader, chunkSize int) error { + if chunkSize <= 0 || chunkSize > MaxBlobBlockSize { + chunkSize = MaxBlobBlockSize + } + + chunk := make([]byte, chunkSize) + n, err := blob.Read(chunk) + if err != nil && err != io.EOF { + return err + } + + if err == io.EOF { + // Fits into one block + return b.putSingleBlockBlob(container, name, chunk[:n]) + } else { + // Does not fit into one block. Upload block by block then commit the block list + blockList := []Block{} + + // Put blocks + for blockNum := 0; ; blockNum++ { + id := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%011d", blockNum))) + data := chunk[:n] + err = b.PutBlock(container, name, id, data) + if err != nil { + return err + } + blockList = append(blockList, Block{id, BlockStatusLatest}) + + // Read next block + n, err = blob.Read(chunk) + if err != nil && err != io.EOF { + return err + } + if err == io.EOF { + break + } + } + + // Commit block list + return b.PutBlockList(container, name, blockList) + } +} + +func (b BlobStorageClient) putSingleBlockBlob(container, name string, chunk []byte) error { + if len(chunk) > MaxBlobBlockSize { + return fmt.Errorf("storage: provided chunk (%d bytes) cannot fit into single-block blob (max %d bytes)", len(chunk), MaxBlobBlockSize) + } + + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{}) + headers := b.client.getStandardHeaders() + headers["x-ms-blob-type"] = string(BlobTypeBlock) + headers["Content-Length"] = fmt.Sprintf("%v", len(chunk)) + + resp, err := b.client.exec("PUT", uri, headers, bytes.NewReader(chunk)) + if err != nil { + return err + } + if resp.statusCode != http.StatusCreated { + return ErrNotCreated + } + + return nil +} + +// PutBlock saves the given data chunk to the specified block blob with +// given ID. See https://msdn.microsoft.com/en-us/library/azure/dd135726.aspx +func (b BlobStorageClient) PutBlock(container, name, blockId string, chunk []byte) error { + return b.PutBlockWithLength(container, name, blockId, uint64(len(chunk)), bytes.NewReader(chunk)) +} + +// PutBlockWithLength saves the given data stream of exactly specified size to the block blob +// with given ID. See https://msdn.microsoft.com/en-us/library/azure/dd135726.aspx +// It is an alternative to PutBlocks where data comes as stream but the length is +// known in advance. +func (b BlobStorageClient) PutBlockWithLength(container, name, blockId string, size uint64, blob io.Reader) error { + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{"comp": {"block"}, "blockid": {blockId}}) + headers := b.client.getStandardHeaders() + headers["x-ms-blob-type"] = string(BlobTypeBlock) + headers["Content-Length"] = fmt.Sprintf("%v", size) + + resp, err := b.client.exec("PUT", uri, headers, blob) + if err != nil { + return err + } + if resp.statusCode != http.StatusCreated { + return ErrNotCreated + } + + return nil +} + +// PutBlockList saves list of blocks to the specified block blob. See +// https://msdn.microsoft.com/en-us/library/azure/dd179467.aspx +func (b BlobStorageClient) PutBlockList(container, name string, blocks []Block) error { + blockListXml := prepareBlockListRequest(blocks) + + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{"comp": {"blocklist"}}) + headers := b.client.getStandardHeaders() + headers["Content-Length"] = fmt.Sprintf("%v", len(blockListXml)) + + resp, err := b.client.exec("PUT", uri, headers, strings.NewReader(blockListXml)) + if err != nil { + return err + } + if resp.statusCode != http.StatusCreated { + return ErrNotCreated + } + return nil +} + +// GetBlockList retrieves list of blocks in the specified block blob. See +// https://msdn.microsoft.com/en-us/library/azure/dd179400.aspx +func (b BlobStorageClient) GetBlockList(container, name string, blockType BlockListType) (BlockListResponse, error) { + params := url.Values{"comp": {"blocklist"}, "blocklisttype": {string(blockType)}} + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), params) + headers := b.client.getStandardHeaders() + + var out BlockListResponse + resp, err := b.client.exec("GET", uri, headers, nil) + if err != nil { + return out, err + } + + err = xmlUnmarshal(resp.body, &out) + return out, err +} + +// PutPageBlob initializes an empty page blob with specified name and maximum +// size in bytes (size must be aligned to a 512-byte boundary). A page blob must +// be created using this method before writing pages. +// See https://msdn.microsoft.com/en-us/library/azure/dd179451.aspx +func (b BlobStorageClient) PutPageBlob(container, name string, size int64) error { + path := fmt.Sprintf("%s/%s", container, name) + uri := b.client.getEndpoint(blobServiceName, path, url.Values{}) + headers := b.client.getStandardHeaders() + headers["x-ms-blob-type"] = string(BlobTypePage) + headers["x-ms-blob-content-length"] = fmt.Sprintf("%v", size) + headers["Content-Length"] = fmt.Sprintf("%v", 0) + + resp, err := b.client.exec("PUT", uri, headers, nil) + if err != nil { + return err + } + if resp.statusCode != http.StatusCreated { + return ErrNotCreated + } + return nil +} + +// PutPage writes a range of pages to a page blob or clears the given range. +// In case of 'clear' writes, given chunk is discarded. Ranges must be aligned +// with 512-byte boundaries and chunk must be of size multiplies by 512. +// See https://msdn.microsoft.com/en-us/library/ee691975.aspx +func (b BlobStorageClient) PutPage(container, name string, startByte, endByte int64, writeType PageWriteType, chunk []byte) error { + path := fmt.Sprintf("%s/%s", container, name) + uri := b.client.getEndpoint(blobServiceName, path, url.Values{"comp": {"page"}}) + headers := b.client.getStandardHeaders() + headers["x-ms-blob-type"] = string(BlobTypePage) + headers["x-ms-page-write"] = string(writeType) + headers["x-ms-range"] = fmt.Sprintf("bytes=%v-%v", startByte, endByte) + + var contentLength int64 + var data io.Reader + if writeType == PageWriteTypeClear { + contentLength = 0 + data = bytes.NewReader([]byte{}) + } else { + contentLength = int64(len(chunk)) + data = bytes.NewReader(chunk) + } + headers["Content-Length"] = fmt.Sprintf("%v", contentLength) + + resp, err := b.client.exec("PUT", uri, headers, data) + if err != nil { + return err + } + if resp.statusCode != http.StatusCreated { + return ErrNotCreated + } + return nil +} + +// GetPageRanges returns the list of valid page ranges for a page blob. +// See https://msdn.microsoft.com/en-us/library/azure/ee691973.aspx +func (b BlobStorageClient) GetPageRanges(container, name string) (GetPageRangesResponse, error) { + path := fmt.Sprintf("%s/%s", container, name) + uri := b.client.getEndpoint(blobServiceName, path, url.Values{"comp": {"pagelist"}}) + headers := b.client.getStandardHeaders() + + var out GetPageRangesResponse + resp, err := b.client.exec("GET", uri, headers, nil) + if err != nil { + return out, err + } + + if resp.statusCode != http.StatusOK { + return out, fmt.Errorf(errUnexpectedStatus, http.StatusOK, resp.statusCode) + } + + err = xmlUnmarshal(resp.body, &out) + return out, err +} + +// CopyBlob starts a blob copy operation and waits for the operation to complete. +// sourceBlob parameter must be a canonical URL to the blob (can be obtained using +// GetBlobURL method.) There is no SLA on blob copy and therefore this helper +// method works faster on smaller files. See https://msdn.microsoft.com/en-us/library/azure/dd894037.aspx +func (b BlobStorageClient) CopyBlob(container, name, sourceBlob string) error { + copyId, err := b.startBlobCopy(container, name, sourceBlob) + if err != nil { + return err + } + + return b.waitForBlobCopy(container, name, copyId) +} + +func (b BlobStorageClient) startBlobCopy(container, name, sourceBlob string) (string, error) { + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{}) + + headers := b.client.getStandardHeaders() + headers["Content-Length"] = "0" + headers["x-ms-copy-source"] = sourceBlob + + resp, err := b.client.exec("PUT", uri, headers, nil) + if err != nil { + return "", err + } + if resp.statusCode != http.StatusAccepted && resp.statusCode != http.StatusCreated { + return "", fmt.Errorf(errUnexpectedStatus, []int{http.StatusAccepted, http.StatusCreated}, resp.statusCode) + } + + copyId := resp.headers.Get("x-ms-copy-id") + if copyId == "" { + return "", errors.New("Got empty copy id header") + } + return copyId, nil +} + +func (b BlobStorageClient) waitForBlobCopy(container, name, copyId string) error { + for { + props, err := b.GetBlobProperties(container, name) + if err != nil { + return err + } + + if props.CopyId != copyId { + return errBlobCopyIdMismatch + } + + switch props.CopyStatus { + case blobCopyStatusSuccess: + return nil + case blobCopyStatusPending: + continue + case blobCopyStatusAborted: + return errBlobCopyAborted + case blobCopyStatusFailed: + return fmt.Errorf("storage: blob copy failed. Id=%s Description=%s", props.CopyId, props.CopyStatusDescription) + default: + return fmt.Errorf("storage: unhandled blob copy status: '%s'", props.CopyStatus) + } + } +} + +// DeleteBlob deletes the given blob from the specified container. +// If the blob does not exists at the time of the Delete Blob operation, it +// returns error. See https://msdn.microsoft.com/en-us/library/azure/dd179413.aspx +func (b BlobStorageClient) DeleteBlob(container, name string) error { + resp, err := b.deleteBlob(container, name) + if err != nil { + return err + } + if resp.statusCode != http.StatusAccepted { + return ErrNotAccepted + } + return nil +} + +// DeleteBlobIfExists deletes the given blob from the specified container +// If the blob is deleted with this call, returns true. Otherwise returns +// false. See https://msdn.microsoft.com/en-us/library/azure/dd179413.aspx +func (b BlobStorageClient) DeleteBlobIfExists(container, name string) (bool, error) { + resp, err := b.deleteBlob(container, name) + if resp != nil && (resp.statusCode == http.StatusAccepted || resp.statusCode == http.StatusNotFound) { + return resp.statusCode == http.StatusAccepted, nil + } + return false, err +} + +func (b BlobStorageClient) deleteBlob(container, name string) (*storageResponse, error) { + verb := "DELETE" + uri := b.client.getEndpoint(blobServiceName, pathForBlob(container, name), url.Values{}) + headers := b.client.getStandardHeaders() + + return b.client.exec(verb, uri, headers, nil) +} + +// helper method to construct the path to a container given its name +func pathForContainer(name string) string { + return fmt.Sprintf("/%s", name) +} + +// helper method to construct the path to a blob given its container and blob name +func pathForBlob(container, name string) string { + return fmt.Sprintf("/%s/%s", container, name) +} + +// GetBlobSASURI creates an URL to the specified blob which contains the Shared Access Signature +// with specified permissions and expiration time. See https://msdn.microsoft.com/en-us/library/azure/ee395415.aspx +func (b BlobStorageClient) GetBlobSASURI(container, name string, expiry time.Time, permissions string) (string, error) { + var ( + signedPermissions = permissions + blobUrl = b.GetBlobUrl(container, name) + ) + canonicalizedResource, err := b.client.buildCanonicalizedResource(blobUrl) + if err != nil { + return "", err + } + signedExpiry := expiry.Format(time.RFC3339) + signedResource := "b" + + stringToSign, err := blobSASStringToSign(b.client.apiVersion, canonicalizedResource, signedExpiry, signedPermissions) + if err != nil { + return "", err + } + + sig := b.client.computeHmac256(stringToSign) + sasParams := url.Values{ + "sv": {b.client.apiVersion}, + "se": {signedExpiry}, + "sr": {signedResource}, + "sp": {signedPermissions}, + "sig": {sig}, + } + + sasUrl, err := url.Parse(blobUrl) + if err != nil { + return "", err + } + sasUrl.RawQuery = sasParams.Encode() + return sasUrl.String(), nil +} + +func blobSASStringToSign(signedVersion, canonicalizedResource, signedExpiry, signedPermissions string) (string, error) { + var signedStart, signedIdentifier, rscc, rscd, rsce, rscl, rsct string + + // reference: http://msdn.microsoft.com/en-us/library/azure/dn140255.aspx + if signedVersion >= "2013-08-15" { + return fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s", signedPermissions, signedStart, signedExpiry, canonicalizedResource, signedIdentifier, signedVersion, rscc, rscd, rsce, rscl, rsct), nil + } else { + return "", errors.New("storage: not implemented SAS for versions earlier than 2013-08-15") + } +} diff --git a/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob_test.go b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob_test.go new file mode 100644 index 00000000..33e3d173 --- /dev/null +++ b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/blob_test.go @@ -0,0 +1,1123 @@ +package storage + +import ( + "bytes" + "crypto/rand" + "encoding/base64" + "errors" + "fmt" + "io/ioutil" + "net/http" + "net/url" + "os" + "reflect" + "sort" + "strings" + "sync" + "testing" + "time" +) + +const testContainerPrefix = "zzzztest-" + +func Test_pathForContainer(t *testing.T) { + out := pathForContainer("foo") + if expected := "/foo"; out != expected { + t.Errorf("Wrong pathForContainer. Expected: '%s', got: '%s'", expected, out) + } +} + +func Test_pathForBlob(t *testing.T) { + out := pathForBlob("foo", "blob") + if expected := "/foo/blob"; out != expected { + t.Errorf("Wrong pathForBlob. Expected: '%s', got: '%s'", expected, out) + } +} + +func Test_blobSASStringToSign(t *testing.T) { + _, err := blobSASStringToSign("2012-02-12", "CS", "SE", "SP") + if err == nil { + t.Fatal("Expected error, got nil") + } + + out, err := blobSASStringToSign("2013-08-15", "CS", "SE", "SP") + if err != nil { + t.Fatal(err) + } + if expected := "SP\n\nSE\nCS\n\n2013-08-15\n\n\n\n\n"; out != expected { + t.Errorf("Wrong stringToSign. Expected: '%s', got: '%s'", expected, out) + } +} + +func TestGetBlobSASURI(t *testing.T) { + api, err := NewClient("foo", "YmFy", DefaultBaseUrl, "2013-08-15", true) + if err != nil { + t.Fatal(err) + } + cli := api.GetBlobService() + expiry := time.Time{} + + expectedParts := url.URL{ + Scheme: "https", + Host: "foo.blob.core.windows.net", + Path: "container/name", + RawQuery: url.Values{ + "sv": {"2013-08-15"}, + "sig": {"/OXG7rWh08jYwtU03GzJM0DHZtidRGpC6g69rSGm3I0="}, + "sr": {"b"}, + "sp": {"r"}, + "se": {"0001-01-01T00:00:00Z"}, + }.Encode()} + + u, err := cli.GetBlobSASURI("container", "name", expiry, "r") + if err != nil { + t.Fatal(err) + } + sasParts, err := url.Parse(u) + if err != nil { + t.Fatal(err) + } + + expectedQuery := expectedParts.Query() + sasQuery := sasParts.Query() + + expectedParts.RawQuery = "" // reset + sasParts.RawQuery = "" + + if expectedParts.String() != sasParts.String() { + t.Fatalf("Base URL wrong for SAS. Expected: '%s', got: '%s'", expectedParts, sasParts) + } + + if len(expectedQuery) != len(sasQuery) { + t.Fatalf("Query string wrong for SAS URL. Expected: '%d keys', got: '%d keys'", len(expectedQuery), len(sasQuery)) + } + + for k, v := range expectedQuery { + out, ok := sasQuery[k] + if !ok { + t.Fatalf("Query parameter '%s' not found in generated SAS query. Expected: '%s'", k, v) + } + if !reflect.DeepEqual(v, out) { + t.Fatalf("Wrong value for query parameter '%s'. Expected: '%s', got: '%s'", k, v, out) + } + } +} + +func TestBlobSASURICorrectness(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + cnt := randContainer() + blob := randString(20) + body := []byte(randString(100)) + expiry := time.Now().UTC().Add(time.Hour) + permissions := "r" + + err = cli.CreateContainer(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + err = cli.PutBlockBlob(cnt, blob, bytes.NewReader(body)) + if err != nil { + t.Fatal(err) + } + + sasUri, err := cli.GetBlobSASURI(cnt, blob, expiry, permissions) + if err != nil { + t.Fatal(err) + } + + resp, err := http.Get(sasUri) + if err != nil { + t.Logf("SAS URI: %s", sasUri) + t.Fatal(err) + } + + blobResp, err := ioutil.ReadAll(resp.Body) + defer resp.Body.Close() + if err != nil { + t.Fatal(err) + } + + if resp.StatusCode != http.StatusOK { + t.Fatalf("Non-ok status code: %s", resp.Status) + } + + if len(blobResp) != len(body) { + t.Fatalf("Wrong blob size on SAS URI. Expected: %d, Got: %d", len(body), len(blobResp)) + } +} + +func TestListContainersPagination(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = deleteTestContainers(cli) + if err != nil { + t.Fatal(err) + } + + const n = 5 + const pageSize = 2 + + // Create test containers + created := []string{} + for i := 0; i < n; i++ { + name := randContainer() + err := cli.CreateContainer(name, ContainerAccessTypePrivate) + if err != nil { + t.Fatalf("Error creating test container: %s", err) + } + created = append(created, name) + } + sort.Strings(created) + + // Defer test container deletions + defer func() { + var wg sync.WaitGroup + for _, cnt := range created { + wg.Add(1) + go func(name string) { + err := cli.DeleteContainer(name) + if err != nil { + t.Logf("Error while deleting test container: %s", err) + } + wg.Done() + }(cnt) + } + wg.Wait() + }() + + // Paginate results + seen := []string{} + marker := "" + for { + resp, err := cli.ListContainers(ListContainersParameters{ + Prefix: testContainerPrefix, + MaxResults: pageSize, + Marker: marker}) + + if err != nil { + t.Fatal(err) + } + + containers := resp.Containers + + if len(containers) > pageSize { + t.Fatalf("Got a bigger page. Expected: %d, got: %d", pageSize, len(containers)) + } + + for _, c := range containers { + seen = append(seen, c.Name) + } + + marker = resp.NextMarker + if marker == "" || len(containers) == 0 { + break + } + } + + // Compare + if !reflect.DeepEqual(created, seen) { + t.Fatalf("Wrong pagination results:\nExpected:\t\t%v\nGot:\t\t%v", created, seen) + } +} + +func TestContainerExists(t *testing.T) { + cnt := randContainer() + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + ok, err := cli.ContainerExists(cnt) + if err != nil { + t.Fatal(err) + } + if ok { + t.Fatalf("Non-existing container returned as existing: %s", cnt) + } + + err = cli.CreateContainer(cnt, ContainerAccessTypeBlob) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + ok, err = cli.ContainerExists(cnt) + if err != nil { + t.Fatal(err) + } + if !ok { + t.Fatalf("Existing container returned as non-existing: %s", cnt) + } +} + +func TestCreateDeleteContainer(t *testing.T) { + cnt := randContainer() + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = cli.CreateContainer(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + err = cli.DeleteContainer(cnt) + if err != nil { + t.Fatal(err) + } +} + +func TestCreateContainerIfNotExists(t *testing.T) { + cnt := randContainer() + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + // First create + ok, err := cli.CreateContainerIfNotExists(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + if expected := true; ok != expected { + t.Fatalf("Wrong creation status. Expected: %v; Got: %v", expected, ok) + } + + // Second create, should not give errors + ok, err = cli.CreateContainerIfNotExists(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + if expected := false; ok != expected { + t.Fatalf("Wrong creation status. Expected: %v; Got: %v", expected, ok) + } + + defer cli.DeleteContainer(cnt) +} + +func TestDeleteContainerIfExists(t *testing.T) { + cnt := randContainer() + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + // Nonexisting container + err = cli.DeleteContainer(cnt) + if err == nil { + t.Fatal("Expected error, got nil") + } + + ok, err := cli.DeleteContainerIfExists(cnt) + if err != nil { + t.Fatalf("Not supposed to return error, got: %s", err) + } + if expected := false; ok != expected { + t.Fatalf("Wrong deletion status. Expected: %v; Got: %v", expected, ok) + } + + // Existing container + err = cli.CreateContainer(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + ok, err = cli.DeleteContainerIfExists(cnt) + if err != nil { + t.Fatalf("Not supposed to return error, got: %s", err) + } + if expected := true; ok != expected { + t.Fatalf("Wrong deletion status. Expected: %v; Got: %v", expected, ok) + } +} + +func TestBlobExists(t *testing.T) { + cnt := randContainer() + blob := randString(20) + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = cli.CreateContainer(cnt, ContainerAccessTypeBlob) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + err = cli.PutBlockBlob(cnt, blob, strings.NewReader("Hello!")) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteBlob(cnt, blob) + + ok, err := cli.BlobExists(cnt, blob+".foo") + if err != nil { + t.Fatal(err) + } + if ok { + t.Errorf("Non-existing blob returned as existing: %s/%s", cnt, blob) + } + + ok, err = cli.BlobExists(cnt, blob) + if err != nil { + t.Fatal(err) + } + if !ok { + t.Errorf("Existing blob returned as non-existing: %s/%s", cnt, blob) + } +} + +func TestGetBlobUrl(t *testing.T) { + api, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + cli := api.GetBlobService() + + out := cli.GetBlobUrl("c", "nested/blob") + if expected := "https://foo.blob.core.windows.net/c/nested/blob"; out != expected { + t.Fatalf("Wrong blob URL. Expected: '%s', got:'%s'", expected, out) + } + + out = cli.GetBlobUrl("", "blob") + if expected := "https://foo.blob.core.windows.net/$root/blob"; out != expected { + t.Fatalf("Wrong blob URL. Expected: '%s', got:'%s'", expected, out) + } + + out = cli.GetBlobUrl("", "nested/blob") + if expected := "https://foo.blob.core.windows.net/$root/nested/blob"; out != expected { + t.Fatalf("Wrong blob URL. Expected: '%s', got:'%s'", expected, out) + } +} + +func TestBlobCopy(t *testing.T) { + if testing.Short() { + t.Skip("skipping blob copy in short mode, no SLA on async operation") + } + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + src := randString(20) + dst := randString(20) + body := []byte(randString(1024)) + + err = cli.CreateContainer(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + err = cli.PutBlockBlob(cnt, src, bytes.NewReader(body)) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteBlob(cnt, src) + + err = cli.CopyBlob(cnt, dst, cli.GetBlobUrl(cnt, src)) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteBlob(cnt, dst) + + blobBody, err := cli.GetBlob(cnt, dst) + if err != nil { + t.Fatal(err) + } + + b, err := ioutil.ReadAll(blobBody) + defer blobBody.Close() + if err != nil { + t.Fatal(err) + } + + if !reflect.DeepEqual(body, b) { + t.Fatalf("Copied blob is wrong. Expected: %d bytes, got: %d bytes\n%s\n%s", len(body), len(b), body, b) + } +} + +func TestDeleteBlobIfExists(t *testing.T) { + cnt := randContainer() + blob := randString(20) + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = cli.DeleteBlob(cnt, blob) + if err == nil { + t.Fatal("Nonexisting blob did not return error") + } + + ok, err := cli.DeleteBlobIfExists(cnt, blob) + if err != nil { + t.Fatalf("Not supposed to return error: %s", err) + } + if expected := false; ok != expected { + t.Fatalf("Wrong deletion status. Expected: %v; Got: %v", expected, ok) + } +} + +func TestGetBlobProperties(t *testing.T) { + cnt := randContainer() + blob := randString(20) + contents := randString(64) + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = cli.CreateContainer(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + // Nonexisting blob + _, err = cli.GetBlobProperties(cnt, blob) + if err == nil { + t.Fatal("Did not return error for non-existing blob") + } + + // Put the blob + err = cli.PutBlockBlob(cnt, blob, strings.NewReader(contents)) + if err != nil { + t.Fatal(err) + } + + // Get blob properties + props, err := cli.GetBlobProperties(cnt, blob) + if err != nil { + t.Fatal(err) + } + + if props.ContentLength != int64(len(contents)) { + t.Fatalf("Got wrong Content-Length: '%d', expected: %d", props.ContentLength, len(contents)) + } + if props.BlobType != BlobTypeBlock { + t.Fatalf("Got wrong BlobType. Expected:'%s', got:'%s'", BlobTypeBlock, props.BlobType) + } +} + +func TestListBlobsPagination(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + err = cli.CreateContainer(cnt, ContainerAccessTypePrivate) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + blobs := []string{} + const n = 5 + const pageSize = 2 + for i := 0; i < n; i++ { + name := randString(20) + err := cli.PutBlockBlob(cnt, name, strings.NewReader("Hello, world!")) + if err != nil { + t.Fatal(err) + } + blobs = append(blobs, name) + } + sort.Strings(blobs) + + // Paginate + seen := []string{} + marker := "" + for { + resp, err := cli.ListBlobs(cnt, ListBlobsParameters{ + MaxResults: pageSize, + Marker: marker}) + if err != nil { + t.Fatal(err) + } + + for _, v := range resp.Blobs { + seen = append(seen, v.Name) + } + + marker = resp.NextMarker + if marker == "" || len(resp.Blobs) == 0 { + break + } + } + + // Compare + if !reflect.DeepEqual(blobs, seen) { + t.Fatalf("Got wrong list of blobs. Expected: %s, Got: %s", blobs, seen) + } + + err = cli.DeleteContainer(cnt) + if err != nil { + t.Fatal(err) + } +} + +func TestPutEmptyBlockBlob(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + err = cli.PutBlockBlob(cnt, blob, bytes.NewReader([]byte{})) + if err != nil { + t.Fatal(err) + } + + props, err := cli.GetBlobProperties(cnt, blob) + if err != nil { + t.Fatal(err) + } + if props.ContentLength != 0 { + t.Fatalf("Wrong content length for empty blob: %d", props.ContentLength) + } +} + +func TestPutSingleBlockBlob(t *testing.T) { + cnt := randContainer() + blob := randString(20) + body := []byte(randString(1024)) + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = cli.CreateContainer(cnt, ContainerAccessTypeBlob) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + err = cli.PutBlockBlob(cnt, blob, bytes.NewReader(body)) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteBlob(cnt, blob) + + resp, err := cli.GetBlob(cnt, blob) + if err != nil { + t.Fatal(err) + } + + // Verify contents + respBody, err := ioutil.ReadAll(resp) + defer resp.Close() + if err != nil { + t.Fatal(err) + } + + if !reflect.DeepEqual(body, respBody) { + t.Fatalf("Wrong blob contents.\nExpected: %d bytes, Got: %d byes", len(body), len(respBody)) + } + + // Verify block list + blocks, err := cli.GetBlockList(cnt, blob, BlockListTypeAll) + if err != nil { + t.Fatal(err) + } + if expected := 1; len(blocks.CommittedBlocks) != expected { + t.Fatalf("Wrong committed block count. Expected: %d, Got: %d", expected, len(blocks.CommittedBlocks)) + } + if expected := 0; len(blocks.UncommittedBlocks) != expected { + t.Fatalf("Wrong unccommitted block count. Expected: %d, Got: %d", expected, len(blocks.UncommittedBlocks)) + } + thatBlock := blocks.CommittedBlocks[0] + if expected := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%011d", 0))); thatBlock.Name != expected { + t.Fatalf("Wrong block name. Expected: %s, Got: %s", expected, thatBlock.Name) + } +} + +func TestGetBlobRange(t *testing.T) { + cnt := randContainer() + blob := randString(20) + body := "0123456789" + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = cli.CreateContainer(cnt, ContainerAccessTypeBlob) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + err = cli.PutBlockBlob(cnt, blob, strings.NewReader(body)) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteBlob(cnt, blob) + + // Read 1-3 + for _, r := range []struct { + rangeStr string + expected string + }{ + {"0-", body}, + {"1-3", body[1 : 3+1]}, + {"3-", body[3:]}, + } { + resp, err := cli.GetBlobRange(cnt, blob, r.rangeStr) + if err != nil { + t.Fatal(err) + } + blobBody, err := ioutil.ReadAll(resp) + if err != nil { + t.Fatal(err) + } + str := string(blobBody) + if str != r.expected { + t.Fatalf("Got wrong range. Expected: '%s'; Got:'%s'", r.expected, str) + } + } +} + +func TestPutBlock(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + chunk := []byte(randString(1024)) + blockId := base64.StdEncoding.EncodeToString([]byte("foo")) + err = cli.PutBlock(cnt, blob, blockId, chunk) + if err != nil { + t.Fatal(err) + } +} + +func TestPutMultiBlockBlob(t *testing.T) { + var ( + cnt = randContainer() + blob = randString(20) + blockSize = 32 * 1024 // 32 KB + body = []byte(randString(blockSize*2 + blockSize/2)) // 3 blocks + ) + + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + err = cli.CreateContainer(cnt, ContainerAccessTypeBlob) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteContainer(cnt) + + err = cli.putBlockBlob(cnt, blob, bytes.NewReader(body), blockSize) + if err != nil { + t.Fatal(err) + } + defer cli.DeleteBlob(cnt, blob) + + resp, err := cli.GetBlob(cnt, blob) + if err != nil { + t.Fatal(err) + } + + // Verify contents + respBody, err := ioutil.ReadAll(resp) + defer resp.Close() + if err != nil { + t.Fatal(err) + } + if !reflect.DeepEqual(body, respBody) { + t.Fatalf("Wrong blob contents.\nExpected: %d bytes, Got: %d byes", len(body), len(respBody)) + } + + err = cli.DeleteBlob(cnt, blob) + if err != nil { + t.Fatal(err) + } + + err = cli.DeleteContainer(cnt) + if err != nil { + t.Fatal(err) + } +} + +func TestGetBlockList_PutBlockList(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + chunk := []byte(randString(1024)) + blockId := base64.StdEncoding.EncodeToString([]byte("foo")) + + // Put one block + err = cli.PutBlock(cnt, blob, blockId, chunk) + if err != nil { + t.Fatal(err) + } + defer cli.deleteBlob(cnt, blob) + + // Get committed blocks + committed, err := cli.GetBlockList(cnt, blob, BlockListTypeCommitted) + if err != nil { + t.Fatal(err) + } + + if len(committed.CommittedBlocks) > 0 { + t.Fatal("There are committed blocks") + } + + // Get uncommitted blocks + uncommitted, err := cli.GetBlockList(cnt, blob, BlockListTypeUncommitted) + if err != nil { + t.Fatal(err) + } + + if expected := 1; len(uncommitted.UncommittedBlocks) != expected { + t.Fatalf("Uncommitted blocks wrong. Expected: %d, got: %d", expected, len(uncommitted.UncommittedBlocks)) + } + + // Commit block list + err = cli.PutBlockList(cnt, blob, []Block{{blockId, BlockStatusUncommitted}}) + if err != nil { + t.Fatal(err) + } + + // Get all blocks + all, err := cli.GetBlockList(cnt, blob, BlockListTypeAll) + if err != nil { + t.Fatal(err) + } + + if expected := 1; len(all.CommittedBlocks) != expected { + t.Fatalf("Uncommitted blocks wrong. Expected: %d, got: %d", expected, len(uncommitted.CommittedBlocks)) + } + if expected := 0; len(all.UncommittedBlocks) != expected { + t.Fatalf("Uncommitted blocks wrong. Expected: %d, got: %d", expected, len(uncommitted.UncommittedBlocks)) + } + + // Verify the block + thatBlock := all.CommittedBlocks[0] + if expected := blockId; expected != thatBlock.Name { + t.Fatalf("Wrong block name. Expected: %s, got: %s", expected, thatBlock.Name) + } + if expected := int64(len(chunk)); expected != thatBlock.Size { + t.Fatalf("Wrong block name. Expected: %d, got: %d", expected, thatBlock.Size) + } +} + +func TestCreateBlockBlob(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + if err := cli.CreateBlockBlob(cnt, blob); err != nil { + t.Fatal(err) + } + + // Verify + blocks, err := cli.GetBlockList(cnt, blob, BlockListTypeAll) + if err != nil { + t.Fatal(err) + } + if expected, got := 0, len(blocks.CommittedBlocks); expected != got { + t.Fatalf("Got wrong committed block count. Expected: %v, Got:%v ", expected, got) + } + if expected, got := 0, len(blocks.UncommittedBlocks); expected != got { + t.Fatalf("Got wrong uncommitted block count. Expected: %v, Got:%v ", expected, got) + } +} + +func TestPutPageBlob(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + size := int64(10 * 1024 * 1024) + if err := cli.PutPageBlob(cnt, blob, size); err != nil { + t.Fatal(err) + } + + // Verify + props, err := cli.GetBlobProperties(cnt, blob) + if err != nil { + t.Fatal(err) + } + if expected := size; expected != props.ContentLength { + t.Fatalf("Got wrong Content-Length. Expected: %v, Got:%v ", expected, props.ContentLength) + } + if expected := BlobTypePage; expected != props.BlobType { + t.Fatalf("Got wrong x-ms-blob-type. Expected: %v, Got:%v ", expected, props.BlobType) + } +} + +func TestPutPagesUpdate(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + size := int64(10 * 1024 * 1024) // larger than we'll use + if err := cli.PutPageBlob(cnt, blob, size); err != nil { + t.Fatal(err) + } + + chunk1 := []byte(randString(1024)) + chunk2 := []byte(randString(512)) + // Append chunks + if err := cli.PutPage(cnt, blob, 0, int64(len(chunk1)-1), PageWriteTypeUpdate, chunk1); err != nil { + t.Fatal(err) + } + if err := cli.PutPage(cnt, blob, int64(len(chunk1)), int64(len(chunk1)+len(chunk2)-1), PageWriteTypeUpdate, chunk2); err != nil { + t.Fatal(err) + } + + // Verify contents + out, err := cli.GetBlobRange(cnt, blob, fmt.Sprintf("%v-%v", 0, len(chunk1)+len(chunk2))) + if err != nil { + t.Fatal(err) + } + blobContents, err := ioutil.ReadAll(out) + defer out.Close() + if err != nil { + t.Fatal(err) + } + if expected := append(chunk1, chunk2...); reflect.DeepEqual(blobContents, expected) { + t.Fatalf("Got wrong blob.\nGot:%d bytes, Expected:%d bytes", len(blobContents), len(expected)) + } + out.Close() + + // Overwrite first half of chunk1 + chunk0 := []byte(randString(512)) + if err := cli.PutPage(cnt, blob, 0, int64(len(chunk0)-1), PageWriteTypeUpdate, chunk0); err != nil { + t.Fatal(err) + } + + // Verify contents + out, err = cli.GetBlobRange(cnt, blob, fmt.Sprintf("%v-%v", 0, len(chunk1)+len(chunk2))) + if err != nil { + t.Fatal(err) + } + blobContents, err = ioutil.ReadAll(out) + defer out.Close() + if err != nil { + t.Fatal(err) + } + if expected := append(append(chunk0, chunk1[512:]...), chunk2...); reflect.DeepEqual(blobContents, expected) { + t.Fatalf("Got wrong blob.\nGot:%d bytes, Expected:%d bytes", len(blobContents), len(expected)) + } +} + +func TestPutPagesClear(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + size := int64(10 * 1024 * 1024) // larger than we'll use + + if err := cli.PutPageBlob(cnt, blob, size); err != nil { + t.Fatal(err) + } + + // Put 0-2047 + chunk := []byte(randString(2048)) + if err := cli.PutPage(cnt, blob, 0, 2047, PageWriteTypeUpdate, chunk); err != nil { + t.Fatal(err) + } + + // Clear 512-1023 + if err := cli.PutPage(cnt, blob, 512, 1023, PageWriteTypeClear, nil); err != nil { + t.Fatal(err) + } + + // Get blob contents + if out, err := cli.GetBlobRange(cnt, blob, "0-2048"); err != nil { + t.Fatal(err) + } else { + contents, err := ioutil.ReadAll(out) + defer out.Close() + if err != nil { + t.Fatal(err) + } + + if expected := append(append(chunk[:512], make([]byte, 512)...), chunk[1024:]...); reflect.DeepEqual(contents, expected) { + t.Fatalf("Cleared blob is not the same. Expected: (%d) %v; got: (%d) %v", len(expected), expected, len(contents), contents) + } + } +} + +func TestGetPageRanges(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + cnt := randContainer() + if err := cli.CreateContainer(cnt, ContainerAccessTypePrivate); err != nil { + t.Fatal(err) + } + defer cli.deleteContainer(cnt) + + blob := randString(20) + size := int64(10 * 1024 * 1024) // larger than we'll use + + if err := cli.PutPageBlob(cnt, blob, size); err != nil { + t.Fatal(err) + } + + // Get page ranges on empty blob + if out, err := cli.GetPageRanges(cnt, blob); err != nil { + t.Fatal(err) + } else if len(out.PageList) != 0 { + t.Fatal("Blob has pages") + } + + // Add 0-512 page + err = cli.PutPage(cnt, blob, 0, 511, PageWriteTypeUpdate, []byte(randString(512))) + if err != nil { + t.Fatal(err) + } + + if out, err := cli.GetPageRanges(cnt, blob); err != nil { + t.Fatal(err) + } else if expected := 1; len(out.PageList) != expected { + t.Fatalf("Expected %d pages, got: %d -- %v", expected, len(out.PageList), out.PageList) + } + + // Add 1024-2048 + err = cli.PutPage(cnt, blob, 1024, 2047, PageWriteTypeUpdate, []byte(randString(1024))) + if err != nil { + t.Fatal(err) + } + + if out, err := cli.GetPageRanges(cnt, blob); err != nil { + t.Fatal(err) + } else if expected := 2; len(out.PageList) != expected { + t.Fatalf("Expected %d pages, got: %d -- %v", expected, len(out.PageList), out.PageList) + } +} + +func deleteTestContainers(cli *BlobStorageClient) error { + for { + resp, err := cli.ListContainers(ListContainersParameters{Prefix: testContainerPrefix}) + if err != nil { + return err + } + if len(resp.Containers) == 0 { + break + } + for _, c := range resp.Containers { + err = cli.DeleteContainer(c.Name) + if err != nil { + return err + } + } + } + return nil +} + +func getBlobClient() (*BlobStorageClient, error) { + name := os.Getenv("ACCOUNT_NAME") + if name == "" { + return nil, errors.New("ACCOUNT_NAME not set, need an empty storage account to test") + } + key := os.Getenv("ACCOUNT_KEY") + if key == "" { + return nil, errors.New("ACCOUNT_KEY not set") + } + cli, err := NewBasicClient(name, key) + if err != nil { + return nil, err + } + return cli.GetBlobService(), nil +} + +func randContainer() string { + return testContainerPrefix + randString(32-len(testContainerPrefix)) +} + +func randString(n int) string { + if n <= 0 { + panic("negative number") + } + const alphanum = "0123456789abcdefghijklmnopqrstuvwxyz" + var bytes = make([]byte, n) + rand.Read(bytes) + for i, b := range bytes { + bytes[i] = alphanum[b%byte(len(alphanum))] + } + return string(bytes) +} diff --git a/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client.go b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client.go new file mode 100644 index 00000000..1cbabaee --- /dev/null +++ b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client.go @@ -0,0 +1,315 @@ +package storage + +import ( + "bytes" + "encoding/base64" + "encoding/xml" + "fmt" + "io" + "io/ioutil" + "net/http" + "net/url" + "regexp" + "sort" + "strings" +) + +const ( + DefaultBaseUrl = "core.windows.net" + DefaultApiVersion = "2014-02-14" + defaultUseHttps = true + + blobServiceName = "blob" + tableServiceName = "table" + queueServiceName = "queue" +) + +// StorageClient is the object that needs to be constructed +// to perform operations on the storage account. +type StorageClient struct { + accountName string + accountKey []byte + useHttps bool + baseUrl string + apiVersion string +} + +type storageResponse struct { + statusCode int + headers http.Header + body io.ReadCloser +} + +// StorageServiceError contains fields of the error response from +// Azure Storage Service REST API. See https://msdn.microsoft.com/en-us/library/azure/dd179382.aspx +// Some fields might be specific to certain calls. +type StorageServiceError struct { + Code string `xml:"Code"` + Message string `xml:"Message"` + AuthenticationErrorDetail string `xml:"AuthenticationErrorDetail"` + QueryParameterName string `xml:"QueryParameterName"` + QueryParameterValue string `xml:"QueryParameterValue"` + Reason string `xml:"Reason"` + StatusCode int + RequestId string +} + +// NewBasicClient constructs a StorageClient with given storage service name +// and key. +func NewBasicClient(accountName, accountKey string) (*StorageClient, error) { + return NewClient(accountName, accountKey, DefaultBaseUrl, DefaultApiVersion, defaultUseHttps) +} + +// NewClient constructs a StorageClient. This should be used if the caller +// wants to specify whether to use HTTPS, a specific REST API version or a +// custom storage endpoint than Azure Public Cloud. +func NewClient(accountName, accountKey, blobServiceBaseUrl, apiVersion string, useHttps bool) (*StorageClient, error) { + if accountName == "" { + return nil, fmt.Errorf("azure: account name required") + } else if accountKey == "" { + return nil, fmt.Errorf("azure: account key required") + } else if blobServiceBaseUrl == "" { + return nil, fmt.Errorf("azure: base storage service url required") + } + + key, err := base64.StdEncoding.DecodeString(accountKey) + if err != nil { + return nil, err + } + + return &StorageClient{ + accountName: accountName, + accountKey: key, + useHttps: useHttps, + baseUrl: blobServiceBaseUrl, + apiVersion: apiVersion}, nil +} + +func (c StorageClient) getBaseUrl(service string) string { + scheme := "http" + if c.useHttps { + scheme = "https" + } + + host := fmt.Sprintf("%s.%s.%s", c.accountName, service, c.baseUrl) + + u := &url.URL{ + Scheme: scheme, + Host: host} + return u.String() +} + +func (c StorageClient) getEndpoint(service, path string, params url.Values) string { + u, err := url.Parse(c.getBaseUrl(service)) + if err != nil { + // really should not be happening + panic(err) + } + + if path == "" { + path = "/" // API doesn't accept path segments not starting with '/' + } + + u.Path = path + u.RawQuery = params.Encode() + return u.String() +} + +// GetBlobService returns a BlobStorageClient which can operate on the +// blob service of the storage account. +func (c StorageClient) GetBlobService() *BlobStorageClient { + return &BlobStorageClient{c} +} + +func (c StorageClient) createAuthorizationHeader(canonicalizedString string) string { + signature := c.computeHmac256(canonicalizedString) + return fmt.Sprintf("%s %s:%s", "SharedKey", c.accountName, signature) +} + +func (c StorageClient) getAuthorizationHeader(verb, url string, headers map[string]string) (string, error) { + canonicalizedResource, err := c.buildCanonicalizedResource(url) + if err != nil { + return "", err + } + + canonicalizedString := c.buildCanonicalizedString(verb, headers, canonicalizedResource) + return c.createAuthorizationHeader(canonicalizedString), nil +} + +func (c StorageClient) getStandardHeaders() map[string]string { + return map[string]string{ + "x-ms-version": c.apiVersion, + "x-ms-date": currentTimeRfc1123Formatted(), + } +} + +func (c StorageClient) buildCanonicalizedHeader(headers map[string]string) string { + cm := make(map[string]string) + + for k, v := range headers { + headerName := strings.TrimSpace(strings.ToLower(k)) + match, _ := regexp.MatchString("x-ms-", headerName) + if match { + cm[headerName] = v + } + } + + if len(cm) == 0 { + return "" + } + + keys := make([]string, 0, len(cm)) + for key := range cm { + keys = append(keys, key) + } + + sort.Strings(keys) + + ch := "" + + for i, key := range keys { + if i == len(keys)-1 { + ch += fmt.Sprintf("%s:%s", key, cm[key]) + } else { + ch += fmt.Sprintf("%s:%s\n", key, cm[key]) + } + } + return ch +} + +func (c StorageClient) buildCanonicalizedResource(uri string) (string, error) { + errMsg := "buildCanonicalizedResource error: %s" + u, err := url.Parse(uri) + if err != nil { + return "", fmt.Errorf(errMsg, err.Error()) + } + + cr := "/" + c.accountName + if len(u.Path) > 0 { + cr += u.Path + } + + params, err := url.ParseQuery(u.RawQuery) + if err != nil { + return "", fmt.Errorf(errMsg, err.Error()) + } + + if len(params) > 0 { + cr += "\n" + keys := make([]string, 0, len(params)) + for key := range params { + keys = append(keys, key) + } + + sort.Strings(keys) + + for i, key := range keys { + if len(params[key]) > 1 { + sort.Strings(params[key]) + } + + if i == len(keys)-1 { + cr += fmt.Sprintf("%s:%s", key, strings.Join(params[key], ",")) + } else { + cr += fmt.Sprintf("%s:%s\n", key, strings.Join(params[key], ",")) + } + } + } + return cr, nil +} + +func (c StorageClient) buildCanonicalizedString(verb string, headers map[string]string, canonicalizedResource string) string { + canonicalizedString := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s", + verb, + headers["Content-Encoding"], + headers["Content-Language"], + headers["Content-Length"], + headers["Content-MD5"], + headers["Content-Type"], + headers["Date"], + headers["If-Modified-Singe"], + headers["If-Match"], + headers["If-None-Match"], + headers["If-Unmodified-Singe"], + headers["Range"], + c.buildCanonicalizedHeader(headers), + canonicalizedResource) + + return canonicalizedString +} + +func (c StorageClient) exec(verb, url string, headers map[string]string, body io.Reader) (*storageResponse, error) { + authHeader, err := c.getAuthorizationHeader(verb, url, headers) + if err != nil { + return nil, err + } + headers["Authorization"] = authHeader + + if err != nil { + return nil, err + } + + req, err := http.NewRequest(verb, url, body) + for k, v := range headers { + req.Header.Add(k, v) + } + httpClient := http.Client{} + resp, err := httpClient.Do(req) + if err != nil { + return nil, err + } + + statusCode := resp.StatusCode + if statusCode >= 400 && statusCode <= 505 { + var respBody []byte + respBody, err = readResponseBody(resp) + if err != nil { + return nil, err + } + + if len(respBody) == 0 { + // no error in response body + err = fmt.Errorf("storage: service returned without a response body (%s).", resp.Status) + } else { + // response contains storage service error object, unmarshal + storageErr, errIn := serviceErrFromXml(respBody, resp.StatusCode, resp.Header.Get("x-ms-request-id")) + if err != nil { // error unmarshaling the error response + err = errIn + } + err = storageErr + } + return &storageResponse{ + statusCode: resp.StatusCode, + headers: resp.Header, + body: ioutil.NopCloser(bytes.NewReader(respBody)), /* restore the body */ + }, err + } + + return &storageResponse{ + statusCode: resp.StatusCode, + headers: resp.Header, + body: resp.Body}, nil +} + +func readResponseBody(resp *http.Response) ([]byte, error) { + defer resp.Body.Close() + out, err := ioutil.ReadAll(resp.Body) + if err == io.EOF { + err = nil + } + return out, err +} + +func serviceErrFromXml(body []byte, statusCode int, requestId string) (StorageServiceError, error) { + var storageErr StorageServiceError + if err := xml.Unmarshal(body, &storageErr); err != nil { + return storageErr, err + } + storageErr.StatusCode = statusCode + storageErr.RequestId = requestId + return storageErr, nil +} + +func (e StorageServiceError) Error() string { + return fmt.Sprintf("storage: remote server returned error. StatusCode=%d, ErrorCode=%s, ErrorMessage=%s, RequestId=%s", e.StatusCode, e.Code, e.Message, e.RequestId) +} diff --git a/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client_test.go b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client_test.go new file mode 100644 index 00000000..844962a6 --- /dev/null +++ b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/client_test.go @@ -0,0 +1,203 @@ +package storage + +import ( + "encoding/base64" + "net/url" + "testing" +) + +func TestGetBaseUrl_Basic_Https(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + + if cli.apiVersion != DefaultApiVersion { + t.Fatalf("Wrong api version. Expected: '%s', got: '%s'", DefaultApiVersion, cli.apiVersion) + } + + if err != nil { + t.Fatal(err) + } + output := cli.getBaseUrl("table") + + if expected := "https://foo.table.core.windows.net"; output != expected { + t.Fatalf("Wrong base url. Expected: '%s', got: '%s'", expected, output) + } +} + +func TestGetBaseUrl_Custom_NoHttps(t *testing.T) { + apiVersion := DefaultApiVersion + cli, err := NewClient("foo", "YmFy", "core.chinacloudapi.cn", apiVersion, false) + if err != nil { + t.Fatal(err) + } + + if cli.apiVersion != apiVersion { + t.Fatalf("Wrong api version. Expected: '%s', got: '%s'", apiVersion, cli.apiVersion) + } + + output := cli.getBaseUrl("table") + + if expected := "http://foo.table.core.chinacloudapi.cn"; output != expected { + t.Fatalf("Wrong base url. Expected: '%s', got: '%s'", expected, output) + } +} + +func TestGetEndpoint_None(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + output := cli.getEndpoint(blobServiceName, "", url.Values{}) + + if expected := "https://foo.blob.core.windows.net/"; output != expected { + t.Fatalf("Wrong endpoint url. Expected: '%s', got: '%s'", expected, output) + } +} + +func TestGetEndpoint_PathOnly(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + output := cli.getEndpoint(blobServiceName, "path", url.Values{}) + + if expected := "https://foo.blob.core.windows.net/path"; output != expected { + t.Fatalf("Wrong endpoint url. Expected: '%s', got: '%s'", expected, output) + } +} + +func TestGetEndpoint_ParamsOnly(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + params := url.Values{} + params.Set("a", "b") + params.Set("c", "d") + output := cli.getEndpoint(blobServiceName, "", params) + + if expected := "https://foo.blob.core.windows.net/?a=b&c=d"; output != expected { + t.Fatalf("Wrong endpoint url. Expected: '%s', got: '%s'", expected, output) + } +} + +func TestGetEndpoint_Mixed(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + params := url.Values{} + params.Set("a", "b") + params.Set("c", "d") + output := cli.getEndpoint(blobServiceName, "path", params) + + if expected := "https://foo.blob.core.windows.net/path?a=b&c=d"; output != expected { + t.Fatalf("Wrong endpoint url. Expected: '%s', got: '%s'", expected, output) + } +} + +func Test_getStandardHeaders(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + + headers := cli.getStandardHeaders() + if len(headers) != 2 { + t.Fatal("Wrong standard header count") + } + if v, ok := headers["x-ms-version"]; !ok || v != cli.apiVersion { + t.Fatal("Wrong version header") + } + if _, ok := headers["x-ms-date"]; !ok { + t.Fatal("Missing date header") + } +} + +func Test_buildCanonicalizedResource(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + + type test struct{ url, expected string } + tests := []test{ + {"https://foo.blob.core.windows.net/path?a=b&c=d", "/foo/path\na:b\nc:d"}, + {"https://foo.blob.core.windows.net/?comp=list", "/foo/\ncomp:list"}, + {"https://foo.blob.core.windows.net/cnt/blob", "/foo/cnt/blob"}, + } + + for _, i := range tests { + if out, err := cli.buildCanonicalizedResource(i.url); err != nil { + t.Fatal(err) + } else if out != i.expected { + t.Fatalf("Wrong canonicalized resource. Expected:\n'%s', Got:\n'%s'", i.expected, out) + } + } +} + +func Test_buildCanonicalizedHeader(t *testing.T) { + cli, err := NewBasicClient("foo", "YmFy") + if err != nil { + t.Fatal(err) + } + + type test struct { + headers map[string]string + expected string + } + tests := []test{ + {map[string]string{}, ""}, + {map[string]string{"x-ms-foo": "bar"}, "x-ms-foo:bar"}, + {map[string]string{"foo:": "bar"}, ""}, + {map[string]string{"foo:": "bar", "x-ms-foo": "bar"}, "x-ms-foo:bar"}, + {map[string]string{ + "x-ms-version": "9999-99-99", + "x-ms-blob-type": "BlockBlob"}, "x-ms-blob-type:BlockBlob\nx-ms-version:9999-99-99"}} + + for _, i := range tests { + if out := cli.buildCanonicalizedHeader(i.headers); out != i.expected { + t.Fatalf("Wrong canonicalized resource. Expected:\n'%s', Got:\n'%s'", i.expected, out) + } + } +} + +func TestReturnsStorageServiceError(t *testing.T) { + cli, err := getBlobClient() + if err != nil { + t.Fatal(err) + } + + // attempt to delete a nonexisting container + _, err = cli.deleteContainer(randContainer()) + if err == nil { + t.Fatal("Service has not returned an error") + } + + if v, ok := err.(StorageServiceError); !ok { + t.Fatal("Cannot assert to specific error") + } else if v.StatusCode != 404 { + t.Fatalf("Expected status:%d, got: %d", 404, v.StatusCode) + } else if v.Code != "ContainerNotFound" { + t.Fatalf("Expected code: %s, got: %s", "ContainerNotFound", v.Code) + } else if v.RequestId == "" { + t.Fatalf("RequestId does not exist") + } +} + +func Test_createAuthorizationHeader(t *testing.T) { + key := base64.StdEncoding.EncodeToString([]byte("bar")) + cli, err := NewBasicClient("foo", key) + if err != nil { + t.Fatal(err) + } + + canonicalizedString := `foobarzoo` + expected := `SharedKey foo:h5U0ATVX6SpbFX1H6GNuxIMeXXCILLoIvhflPtuQZ30=` + + if out := cli.createAuthorizationHeader(canonicalizedString); out != expected { + t.Fatalf("Wrong authorization header. Expected: '%s', Got:'%s'", expected, out) + } +} diff --git a/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util.go b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util.go new file mode 100644 index 00000000..8a0f7b94 --- /dev/null +++ b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util.go @@ -0,0 +1,63 @@ +package storage + +import ( + "crypto/hmac" + "crypto/sha256" + "encoding/base64" + "encoding/xml" + "fmt" + "io" + "io/ioutil" + "net/http" + "net/url" + "time" +) + +func (c StorageClient) computeHmac256(message string) string { + h := hmac.New(sha256.New, c.accountKey) + h.Write([]byte(message)) + return base64.StdEncoding.EncodeToString(h.Sum(nil)) +} + +func currentTimeRfc1123Formatted() string { + return timeRfc1123Formatted(time.Now().UTC()) +} + +func timeRfc1123Formatted(t time.Time) string { + return t.Format(http.TimeFormat) +} + +func mergeParams(v1, v2 url.Values) url.Values { + out := url.Values{} + for k, v := range v1 { + out[k] = v + } + for k, v := range v2 { + vals, ok := out[k] + if ok { + vals = append(vals, v...) + out[k] = vals + } else { + out[k] = v + } + } + return out +} + +func prepareBlockListRequest(blocks []Block) string { + s := `` + for _, v := range blocks { + s += fmt.Sprintf("<%s>%s", v.Status, v.Id, v.Status) + } + s += `` + return s +} + +func xmlUnmarshal(body io.ReadCloser, v interface{}) error { + data, err := ioutil.ReadAll(body) + if err != nil { + return err + } + defer body.Close() + return xml.Unmarshal(data, v) +} diff --git a/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util_test.go b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util_test.go new file mode 100644 index 00000000..d1b2c794 --- /dev/null +++ b/Godeps/_workspace/src/github.com/MSOpenTech/azure-sdk-for-go/clients/storage/util_test.go @@ -0,0 +1,80 @@ +package storage + +import ( + "io/ioutil" + "net/url" + "reflect" + "strings" + "testing" + "time" +) + +func Test_timeRfc1123Formatted(t *testing.T) { + now := time.Now().UTC() + + expectedLayout := "Mon, 02 Jan 2006 15:04:05 GMT" + expected := now.Format(expectedLayout) + + if output := timeRfc1123Formatted(now); output != expected { + t.Errorf("Expected: %s, got: %s", expected, output) + } +} + +func Test_mergeParams(t *testing.T) { + v1 := url.Values{ + "k1": {"v1"}, + "k2": {"v2"}} + v2 := url.Values{ + "k1": {"v11"}, + "k3": {"v3"}} + + out := mergeParams(v1, v2) + if v := out.Get("k1"); v != "v1" { + t.Errorf("Wrong value for k1: %s", v) + } + + if v := out.Get("k2"); v != "v2" { + t.Errorf("Wrong value for k2: %s", v) + } + + if v := out.Get("k3"); v != "v3" { + t.Errorf("Wrong value for k3: %s", v) + } + + if v := out["k1"]; !reflect.DeepEqual(v, []string{"v1", "v11"}) { + t.Errorf("Wrong multi-value for k1: %s", v) + } +} + +func Test_prepareBlockListRequest(t *testing.T) { + empty := []Block{} + expected := `` + if out := prepareBlockListRequest(empty); expected != out { + t.Errorf("Wrong block list. Expected: '%s', got: '%s'", expected, out) + } + + blocks := []Block{{"foo", BlockStatusLatest}, {"bar", BlockStatusUncommitted}} + expected = `foobar` + if out := prepareBlockListRequest(blocks); expected != out { + t.Errorf("Wrong block list. Expected: '%s', got: '%s'", expected, out) + } +} + +func Test_xmlUnmarshal(t *testing.T) { + xml := ` + + myblob + ` + + body := ioutil.NopCloser(strings.NewReader(xml)) + + var blob Blob + err := xmlUnmarshal(body, &blob) + if err != nil { + t.Fatal(err) + } + + if blob.Name != "myblob" { + t.Fatal("Got wrong value") + } +}