[Storage] BlobSASSignatureValues could use BlobSASPermissions type fo…

…r `permissions` instead of string (#5626) * BlobSASSignatureValues could use BlobSASPermissions type for permissions * updating the tests
Azure · Oct 18, 2019 · efbcb75 · efbcb75
1 parent 7187c1f
commit efbcb75
Show file tree

Hide file tree

Showing 17 changed files with 78 additions and 63 deletions.
diff --git a/sdk/storage/storage-blob/src/AccountSASSignatureValues.ts b/sdk/storage/storage-blob/src/AccountSASSignatureValues.ts
@@ -65,10 +65,10 @@ export interface AccountSASSignatureValues {
    * Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help
    * constructing the permissions string.
    *
-   * @type {string}
+   * @type {AccountSASPermissions}
    * @memberof AccountSASSignatureValues
    */
-  permissions: string;
+  permissions: AccountSASPermissions;
 
   /**
    * Optional. IP range allowed.
@@ -118,8 +118,8 @@ export function generateAccountSASQueryParameters(
     : SERVICE_VERSION;
 
   const parsedPermissions = AccountSASPermissions.parse(
-    accountSASSignatureValues.permissions
-  ).toString();
+    accountSASSignatureValues.permissions.toString()
+  );
   const parsedServices = AccountSASServices.parse(accountSASSignatureValues.services).toString();
   const parsedResourceTypes = AccountSASResourceTypes.parse(
     accountSASSignatureValues.resourceTypes
@@ -145,7 +145,7 @@ export function generateAccountSASQueryParameters(
   return new SASQueryParameters(
     version,
     signature,
-    parsedPermissions,
+    parsedPermissions.toString(),
     parsedServices,
     parsedResourceTypes,
     accountSASSignatureValues.protocol,

diff --git a/sdk/storage/storage-blob/src/BlobSASSignatureValues.ts b/sdk/storage/storage-blob/src/BlobSASSignatureValues.ts
@@ -59,10 +59,10 @@ export interface BlobSASSignatureValues {
    * Please refer to either {@link ContainerSASPermissions} or {@link BlobSASPermissions} depending on the resource
    * being accessed for help constructing the permissions string.
    *
-   * @type {string}
+   * @type {BlobSASPermissions}
    * @memberof BlobSASSignatureValues
    */
-  permissions?: string;
+  permissions?: BlobSASPermissions;
 
   /**
    * Optional. IP ranges allowed in this SAS.
@@ -359,11 +359,13 @@ function generateBlobSASQueryParameters20150405(
   // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
   if (blobSASSignatureValues.permissions) {
     if (blobSASSignatureValues.blobName) {
-      verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions).toString();
+      verifiedPermissions = BlobSASPermissions.parse(
+        blobSASSignatureValues.permissions.toString()
+      ).toString();
       resource = "b";
     } else {
       verifiedPermissions = ContainerSASPermissions.parse(
-        blobSASSignatureValues.permissions
+        blobSASSignatureValues.permissions.toString()
       ).toString();
     }
   }
@@ -456,14 +458,16 @@ function generateBlobSASQueryParameters20181109(
   // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
   if (blobSASSignatureValues.permissions) {
     if (blobSASSignatureValues.blobName) {
-      verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions).toString();
+      verifiedPermissions = BlobSASPermissions.parse(
+        blobSASSignatureValues.permissions.toString()
+      ).toString();
       resource = "b";
       if (blobSASSignatureValues.snapshotTime) {
         resource = "bs";
       }
     } else {
       verifiedPermissions = ContainerSASPermissions.parse(
-        blobSASSignatureValues.permissions
+        blobSASSignatureValues.permissions.toString()
       ).toString();
     }
   }
@@ -553,14 +557,16 @@ function generateBlobSASQueryParametersUDK20181109(
   // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
   if (blobSASSignatureValues.permissions) {
     if (blobSASSignatureValues.blobName) {
-      verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions).toString();
+      verifiedPermissions = BlobSASPermissions.parse(
+        blobSASSignatureValues.permissions.toString()
+      ).toString();
       resource = "b";
       if (blobSASSignatureValues.snapshotTime) {
         resource = "bs";
       }
     } else {
       verifiedPermissions = ContainerSASPermissions.parse(
-        blobSASSignatureValues.permissions
+        blobSASSignatureValues.permissions.toString()
       ).toString();
     }
   }

diff --git a/sdk/storage/storage-blob/test/node/appendblobclient.spec.ts b/sdk/storage/storage-blob/test/node/appendblobclient.spec.ts
@@ -128,7 +128,7 @@ describe("AppendBlobClient Node.js only", () => {
         expiryTime,
         containerName,
         blobName: blockBlobName,
-        permissions: BlobSASPermissions.parse("r").toString()
+        permissions: BlobSASPermissions.parse("r")
       },
       credential
     );
@@ -162,7 +162,7 @@ describe("AppendBlobClient Node.js only", () => {
         expiryTime,
         containerName,
         blobName: blockBlobName,
-        permissions: BlobSASPermissions.parse("r").toString()
+        permissions: BlobSASPermissions.parse("r")
       },
       credential
     );

diff --git a/sdk/storage/storage-blob/test/node/blobclient.spec.ts b/sdk/storage/storage-blob/test/node/blobclient.spec.ts
@@ -236,7 +236,7 @@ describe("BlobClient Node.js only", () => {
     const sas = generateBlobSASQueryParameters(
       {
         expiryTime,
-        permissions: BlobSASPermissions.parse("racwd").toString(),
+        permissions: BlobSASPermissions.parse("racwd"),
         containerName,
         blobName
       },

diff --git a/sdk/storage/storage-blob/test/node/containerclient.spec.ts b/sdk/storage/storage-blob/test/node/containerclient.spec.ts
@@ -2,7 +2,12 @@ import * as assert from "assert";
 
 import { getBSU, getConnectionStringFromEnvironment } from "../utils";
 import { PublicAccessType } from "../../src/generated/src/models/index";
-import { ContainerClient, newPipeline, SharedKeyCredential } from "../../src";
+import {
+  ContainerClient,
+  newPipeline,
+  SharedKeyCredential,
+  ContainerSASPermissions
+} from "../../src";
 import { TokenCredential } from "@azure/core-http";
 import { assertClientUsesTokenCredential } from "../utils/assert";
 import { record } from "../utils/recorder";
@@ -41,7 +46,7 @@ describe("ContainerClient Node.js only", () => {
       {
         accessPolicy: {
           expiry: new Date("2018-12-31T11:22:33.4567890Z"),
-          permissions: "rwd",
+          permissions: ContainerSASPermissions.parse("rwd").toString(),
           start: new Date("2017-12-31T11:22:33.4567890Z")
         },
         id: "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI="
@@ -59,7 +64,7 @@ describe("ContainerClient Node.js only", () => {
     const containerAcl = [
       {
         accessPolicy: {
-          permissions: "rwd"
+          permissions: ContainerSASPermissions.parse("rwd").toString()
         },
         id: "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI="
       }

diff --git a/sdk/storage/storage-blob/test/node/pageblobclient.spec.ts b/sdk/storage/storage-blob/test/node/pageblobclient.spec.ts
@@ -138,7 +138,7 @@ describe("PageBlobClient Node.js only", () => {
         expiryTime,
         containerName,
         blobName: blockBlobName,
-        permissions: BlobSASPermissions.parse("r").toString()
+        permissions: BlobSASPermissions.parse("r")
       },
       sharedKeyCredential as SharedKeyCredential
     );
@@ -259,7 +259,7 @@ describe("PageBlobClient Node.js only", () => {
         expiryTime,
         containerName,
         blobName: blockBlobName,
-        permissions: BlobSASPermissions.parse("r").toString()
+        permissions: BlobSASPermissions.parse("r")
       },
       credential
     );

diff --git a/sdk/storage/storage-blob/test/node/sas.spec.ts b/sdk/storage/storage-blob/test/node/sas.spec.ts
@@ -47,7 +47,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
       {
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: AccountSASPermissions.parse("rwdlacup").toString(),
+        permissions: AccountSASPermissions.parse("rwdlacup"),
         protocol: SASProtocol.HttpsAndHttp,
         resourceTypes: AccountSASResourceTypes.parse("sco").toString(),
         services: AccountSASServices.parse("btqf").toString(),
@@ -77,7 +77,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
     const sas = generateAccountSASQueryParameters(
       {
         expiryTime: tmr,
-        permissions: AccountSASPermissions.parse("wdlcup").toString(),
+        permissions: AccountSASPermissions.parse("wdlcup"),
         resourceTypes: AccountSASResourceTypes.parse("sco").toString(),
         services: AccountSASServices.parse("btqf").toString()
       },
@@ -111,7 +111,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
     const sas = generateAccountSASQueryParameters(
       {
         expiryTime: tmr,
-        permissions: AccountSASPermissions.parse("rwdlacup").toString(),
+        permissions: AccountSASPermissions.parse("rwdlacup"),
         resourceTypes: AccountSASResourceTypes.parse("sco").toString(),
         services: AccountSASServices.parse("tqf").toString()
       },
@@ -146,7 +146,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
       {
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: AccountSASPermissions.parse("rwdlacup").toString(),
+        permissions: AccountSASPermissions.parse("rwdlacup"),
         protocol: SASProtocol.HttpsAndHttp,
         resourceTypes: AccountSASResourceTypes.parse("co").toString(),
         services: AccountSASServices.parse("btqf").toString(),
@@ -191,7 +191,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         containerName: containerClient.containerName,
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: ContainerSASPermissions.parse("racwdl").toString(),
+        permissions: ContainerSASPermissions.parse("racwdl"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now,
         version: "2016-05-31"
@@ -245,7 +245,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         contentType: "content-type-override",
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: BlobSASPermissions.parse("racwd").toString(),
+        permissions: BlobSASPermissions.parse("racwd"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now,
         version: "2016-05-31"
@@ -300,7 +300,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         contentType: "content-type-override",
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: BlobSASPermissions.parse("racwd").toString(),
+        permissions: BlobSASPermissions.parse("racwd"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now
       },
@@ -356,7 +356,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         contentType: "content-type-override",
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: BlobSASPermissions.parse("racwd").toString(),
+        permissions: BlobSASPermissions.parse("racwd"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now,
         snapshotTime: response.snapshot
@@ -413,7 +413,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         contentType: "content-type-override",
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: BlobSASPermissions.parse("racwd").toString(),
+        permissions: BlobSASPermissions.parse("racwd"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now,
         version: "2016-05-31"
@@ -514,7 +514,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         containerName: containerClient.containerName,
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: ContainerSASPermissions.parse("racwdl").toString(),
+        permissions: ContainerSASPermissions.parse("racwdl"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now,
         version: "2019-02-02"
@@ -569,7 +569,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
       {
         containerName: containerClient.containerName,
         expiryTime: tmr,
-        permissions: ContainerSASPermissions.parse("racwdl").toString()
+        permissions: ContainerSASPermissions.parse("racwdl")
       },
       userDelegationKey,
       accountName
@@ -636,7 +636,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         contentType: "content-type-override",
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: BlobSASPermissions.parse("racwd").toString(),
+        permissions: BlobSASPermissions.parse("racwd"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now
       },
@@ -707,7 +707,7 @@ describe("Shared Access Signature (SAS) generation Node.js only", () => {
         contentType: "content-type-override",
         expiryTime: tmr,
         ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-        permissions: BlobSASPermissions.parse("racwd").toString(),
+        permissions: BlobSASPermissions.parse("racwd"),
         protocol: SASProtocol.HttpsAndHttp,
         startTime: now,
         snapshotTime: response.snapshot

diff --git a/sdk/storage/storage-blob/test/utils/index.ts b/sdk/storage/storage-blob/test/utils/index.ts
@@ -190,7 +190,7 @@ export function getSASConnectionStringFromEnvironment(): string {
     {
       expiryTime: tmr,
       ipRange: { start: "0.0.0.0", end: "255.255.255.255" },
-      permissions: AccountSASPermissions.parse("rwdlacup").toString(),
+      permissions: AccountSASPermissions.parse("rwdlacup"),
       protocol: SASProtocol.HttpsAndHttp,
       resourceTypes: AccountSASResourceTypes.parse("sco").toString(),
       services: AccountSASServices.parse("btqf").toString(),

diff --git a/sdk/storage/storage-file/src/AccountSASSignatureValues.ts b/sdk/storage/storage-file/src/AccountSASSignatureValues.ts
@@ -65,10 +65,10 @@ export interface AccountSASSignatureValues {
    * Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help
    * constructing the permissions string.
    *
-   * @type {string}
+   * @type {AccountSASPermissions}
    * @memberof AccountSASSignatureValues
    */
-  permissions: string;
+  permissions: AccountSASPermissions;
 
   /**
    * Optional. IP range allowed.
@@ -118,7 +118,7 @@ export function generateAccountSASQueryParameters(
     : SERVICE_VERSION;
 
   const parsedPermissions = AccountSASPermissions.parse(
-    accountSASSignatureValues.permissions
+    accountSASSignatureValues.permissions.toString()
   ).toString();
   const parsedServices = AccountSASServices.parse(accountSASSignatureValues.services).toString();
   const parsedResourceTypes = AccountSASResourceTypes.parse(

diff --git a/sdk/storage/storage-file/src/FileSASSignatureValues.ts b/sdk/storage/storage-file/src/FileSASSignatureValues.ts
@@ -57,10 +57,10 @@ export interface FileSASSignatureValues {
    * Please refer to either {@link ShareSASPermissions} or {@link FileSASPermissions} depending on the resource
    * being accessed for help constructing the permissions string.
    *
-   * @type {string}
+   * @type {FileSASPermissions}
    * @memberof FileSASSignatureValues
    */
-  permissions?: string;
+  permissions?: FileSASPermissions;
 
   /**
    * Optional. IP ranges allowed in this SAS.
@@ -174,11 +174,13 @@ export function generateFileSASQueryParameters(
   // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
   if (fileSASSignatureValues.permissions) {
     if (fileSASSignatureValues.filePath) {
-      verifiedPermissions = FileSASPermissions.parse(fileSASSignatureValues.permissions).toString();
+      verifiedPermissions = FileSASPermissions.parse(
+        fileSASSignatureValues.permissions.toString()
+      ).toString();
       resource = "f";
     } else {
       verifiedPermissions = ShareSASPermissions.parse(
-        fileSASSignatureValues.permissions
+        fileSASSignatureValues.permissions.toString()
       ).toString();
     }
   }

diff --git a/sdk/storage/storage-file/test/node/fileclient.spec.ts b/sdk/storage/storage-file/test/node/fileclient.spec.ts
@@ -166,7 +166,7 @@ describe("FileClient Node.js only", () => {
         expiryTime,
         shareName,
         filePath: `${dirName}/${fileName}`,
-        permissions: FileSASPermissions.parse("r").toString()
+        permissions: FileSASPermissions.parse("r")
       },
       credential
     );