Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added client side checks for account set props #7426

Merged
merged 7 commits into from
Jan 15, 2020
Merged

Added client side checks for account set props #7426

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
de9974f
Added checks for account set props
gapra-msft Jan 14, 2020
8940b34
Fixed checkstyle
gapra-msft Jan 14, 2020
d038f39
Added more checks and test recording
gapra-msft Jan 15, 2020
aef2bf8
test Recordings
gapra-msft Jan 15, 2020
3b48381
Added comments to test and private methods
gapra-msft Jan 15, 2020
ef5e21f
Merge branch 'master' into storage/accountSetProps
gapra-msft Jan 15, 2020
75739f8
Added javadoc and Changelog
gapra-msft Jan 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 84 additions & 1 deletion ...orage/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobServiceAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import com.azure.storage.blob.implementation.models.ServiceGetAccountInfoHeaders;
import com.azure.storage.blob.implementation.models.ServicesListBlobContainersSegmentResponse;
import com.azure.storage.blob.models.BlobContainerItem;
import com.azure.storage.blob.models.BlobCorsRule;
import com.azure.storage.blob.models.BlobRetentionPolicy;
import com.azure.storage.blob.models.BlobServiceProperties;
import com.azure.storage.blob.models.BlobServiceStatistics;
import com.azure.storage.blob.models.CpkInfo;
Expand All @@ -38,6 +40,8 @@

import java.time.Duration;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Function;

Expand Down Expand Up @@ -391,10 +395,89 @@ public Mono<Response<Void>> setPropertiesWithResponse(BlobServiceProperties prop
}

Mono<Response<Void>> setPropertiesWithResponse(BlobServiceProperties properties, Context context) {
return this.azureBlobStorage.services().setPropertiesWithRestResponseAsync(properties, null, null, context)
BlobServiceProperties finalProperties = null;
if (properties != null) {
finalProperties = new BlobServiceProperties();

// Logging
finalProperties.setLogging(properties.getLogging());
if (finalProperties.getLogging() != null) {
StorageImplUtils.assertNotNull("Logging Version", finalProperties.getLogging().getVersion());
validateRetentionPolicy(finalProperties.getLogging().getRetentionPolicy(), "Logging Retention Policy");
}

// Hour Metrics
finalProperties.setHourMetrics(properties.getHourMetrics());
if (finalProperties.getHourMetrics() != null) {
StorageImplUtils.assertNotNull("HourMetrics Version", finalProperties.getHourMetrics().getVersion());
validateRetentionPolicy(finalProperties.getHourMetrics().getRetentionPolicy(), "HourMetrics Retention "
+ "Policy");
if (finalProperties.getHourMetrics().isEnabled()) {
StorageImplUtils.assertNotNull("HourMetrics IncludeApis",
finalProperties.getHourMetrics().isIncludeApis());
}
}

// Minute Metrics
finalProperties.setMinuteMetrics(properties.getMinuteMetrics());
if (finalProperties.getMinuteMetrics() != null) {
StorageImplUtils.assertNotNull("MinuteMetrics Version",
finalProperties.getMinuteMetrics().getVersion());
validateRetentionPolicy(finalProperties.getMinuteMetrics().getRetentionPolicy(), "MinuteMetrics "
+ "Retention Policy");
if (finalProperties.getMinuteMetrics().isEnabled()) {
StorageImplUtils.assertNotNull("MinuteMetrics IncludeApis",
finalProperties.getHourMetrics().isIncludeApis());
}
}

// CORS
if (properties.getCors() != null) {
List<BlobCorsRule> corsRules = new ArrayList<>();
for (BlobCorsRule rule : properties.getCors()) {
corsRules.add(validatedCorsRule(rule));
}
finalProperties.setCors(corsRules);
}

// Default Service Version
finalProperties.setDefaultServiceVersion(properties.getDefaultServiceVersion());

// Delete Retention Policy
finalProperties.setDeleteRetentionPolicy(properties.getDeleteRetentionPolicy());
validateRetentionPolicy(finalProperties.getDeleteRetentionPolicy(), "DeleteRetentionPolicy Days");

// Static Website
finalProperties.setStaticWebsite(properties.getStaticWebsite());

}

return this.azureBlobStorage.services().setPropertiesWithRestResponseAsync(finalProperties, null, null, context)
.map(response -> new SimpleResponse<>(response, null));
}

private BlobCorsRule validatedCorsRule(BlobCorsRule originalRule) {
gapra-msft marked this conversation as resolved.
Show resolved Hide resolved
if (originalRule == null) {
return null;
}
BlobCorsRule validRule = new BlobCorsRule();
validRule.setAllowedHeaders(StorageImplUtils.emptyIfNull(originalRule.getAllowedHeaders()));
validRule.setAllowedMethods(StorageImplUtils.emptyIfNull(originalRule.getAllowedMethods()));
validRule.setAllowedOrigins(StorageImplUtils.emptyIfNull(originalRule.getAllowedOrigins()));
validRule.setExposedHeaders(StorageImplUtils.emptyIfNull(originalRule.getExposedHeaders()));
validRule.setMaxAgeInSeconds(originalRule.getMaxAgeInSeconds());
return validRule;
}

private void validateRetentionPolicy(BlobRetentionPolicy retentionPolicy, String policyName) {
if (retentionPolicy == null) {
return;
}
if (retentionPolicy.isEnabled()) {
StorageImplUtils.assertInBounds(policyName, retentionPolicy.getDays(), 1, 365);
}
}

/**
* Gets a user delegation key for use with this account's blob storage. Note: This method call is only valid when
* using {@link TokenCredential} in this object's {@link HttpPipeline}.
Expand Down
16 changes: 16 additions & 0 deletions sdk/storage/azure-storage-blob/src/test/java/com/azure/storage/blob/ServiceAPITest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,22 @@ class ServiceAPITest extends APISpec {
primaryBlobServiceClient.setPropertiesWithResponse(sentProperties, null, null).getStatusCode() == 202
}

def "Set props cors check"() {
setup:
def serviceProperties = primaryBlobServiceClient.getProperties()

def rule = new BlobCorsRule()
rule.setAllowedOrigins("microsoft.com")
rule.setMaxAgeInSeconds(60)
rule.setAllowedMethods("GET")
rule.setAllowedHeaders("x-ms-version")

serviceProperties.setCors(Collections.singletonList(rule))

gapra-msft marked this conversation as resolved.
Show resolved Hide resolved
expect:
primaryBlobServiceClient.setPropertiesWithResponse(serviceProperties, null, null).getStatusCode() == 202
}

def "Set props error"() {
when:
getServiceClient(primaryCredential, "https://error.blob.core.windows.net")
Expand Down
148 changes: 148 additions & 0 deletions ...zure-storage-blob/src/test/resources/session-records/ServiceAPITestsetpropscorscheck.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
{
"networkCallRecords" : [ {
"Method" : "PUT",
"Uri" : "https://gaprastg71.blob.core.windows.net/jtcsetpropscorscheck0serviceapitestsetpropscorscheckd2d100161?restype=container",
"Headers" : {
"x-ms-version" : "2019-02-02",
"User-Agent" : "azsdk-java-azure-storage-blob/12.3.0-beta.1 (11.0.4; Windows 10 10.0)",
"x-ms-client-request-id" : "5d549ef1-ca87-4776-be9f-3b73920314a6"
},
"Response" : {
"x-ms-version" : "2019-02-02",
"Server" : "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"ETag" : "0x8D799E4A7F4D6C3",
"Last-Modified" : "Wed, 15 Jan 2020 17:59:24 GMT",
"retry-after" : "0",
"Content-Length" : "0",
"StatusCode" : "201",
"x-ms-request-id" : "67fe4ef4-f01e-002d-44cd-cb2148000000",
"Date" : "Wed, 15 Jan 2020 17:59:23 GMT",
"x-ms-client-request-id" : "5d549ef1-ca87-4776-be9f-3b73920314a6"
},
"Exception" : null
}, {
"Method" : "PUT",
"Uri" : "https://gaprastg71.blob.core.windows.net?restype=service&comp=properties",
"Headers" : {
"x-ms-version" : "2019-02-02",
"User-Agent" : "azsdk-java-azure-storage-blob/12.3.0-beta.1 (11.0.4; Windows 10 10.0)",
"x-ms-client-request-id" : "ccf3bbf7-7dfa-463f-b195-500ae58eaf72",
"Content-Type" : "application/xml; charset=utf-8"
},
"Response" : {
"x-ms-version" : "2019-02-02",
"Server" : "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"retry-after" : "0",
"Content-Length" : "0",
"StatusCode" : "202",
"x-ms-request-id" : "67fe4ef7-f01e-002d-45cd-cb2148000000",
"Date" : "Wed, 15 Jan 2020 17:59:25 GMT",
"x-ms-client-request-id" : "ccf3bbf7-7dfa-463f-b195-500ae58eaf72"
},
"Exception" : null
}, {
"Method" : "GET",
"Uri" : "https://gaprastg71.blob.core.windows.net?restype=service&comp=properties",
"Headers" : {
"x-ms-version" : "2019-02-02",
"User-Agent" : "azsdk-java-azure-storage-blob/12.3.0-beta.1 (11.0.4; Windows 10 10.0)",
"x-ms-client-request-id" : "ced55d39-dd7a-472c-8ec2-10a9a29fc758"
},
"Response" : {
"Transfer-Encoding" : "chunked",
"x-ms-version" : "2019-02-02",
"Server" : "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"Vary" : "Origin",
"retry-after" : "0",
"StatusCode" : "200",
"x-ms-request-id" : "67fe4f0d-f01e-002d-4dcd-cb2148000000",
"Body" : "<?xml version=\"1.0\" encoding=\"utf-8\"?><StorageServiceProperties><Logging><Version>1.0</Version><Read>false</Read><Write>false</Write><Delete>false</Delete><RetentionPolicy><Enabled>false</Enabled></RetentionPolicy></Logging><HourMetrics><Version>1.0</Version><Enabled>false</Enabled><RetentionPolicy><Enabled>false</Enabled></RetentionPolicy></HourMetrics><MinuteMetrics><Version>1.0</Version><Enabled>false</Enabled><RetentionPolicy><Enabled>false</Enabled></RetentionPolicy></MinuteMetrics><Cors><CorsRule><AllowedMethods>GET</AllowedMethods><AllowedOrigins>microsoft.com</AllowedOrigins><AllowedHeaders>x-ms-version</AllowedHeaders><ExposedHeaders /><MaxAgeInSeconds>60</MaxAgeInSeconds></CorsRule></Cors><DeleteRetentionPolicy><Enabled>false</Enabled></DeleteRetentionPolicy><StaticWebsite><Enabled>false</Enabled></StaticWebsite><DefaultServiceVersion>2018-03-28</DefaultServiceVersion></StorageServiceProperties>",
"Date" : "Wed, 15 Jan 2020 17:59:25 GMT",
"x-ms-client-request-id" : "ced55d39-dd7a-472c-8ec2-10a9a29fc758",
"Content-Type" : "application/xml"
},
"Exception" : null
}, {
"Method" : "PUT",
"Uri" : "https://gaprastg71.blob.core.windows.net?restype=service&comp=properties",
"Headers" : {
"x-ms-version" : "2019-02-02",
"User-Agent" : "azsdk-java-azure-storage-blob/12.3.0-beta.1 (11.0.4; Windows 10 10.0)",
"x-ms-client-request-id" : "e0f37959-0eca-4653-b724-f88b30984501",
"Content-Type" : "application/xml; charset=utf-8"
},
"Response" : {
"x-ms-version" : "2019-02-02",
"Server" : "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"retry-after" : "0",
"Content-Length" : "0",
"StatusCode" : "202",
"x-ms-request-id" : "67fe4f10-f01e-002d-4fcd-cb2148000000",
"Date" : "Wed, 15 Jan 2020 17:59:25 GMT",
"x-ms-client-request-id" : "e0f37959-0eca-4653-b724-f88b30984501"
},
"Exception" : null
}, {
"Method" : "PUT",
"Uri" : "https://gaprastg71.blob.core.windows.net?restype=service&comp=properties",
"Headers" : {
"x-ms-version" : "2019-02-02",
"User-Agent" : "azsdk-java-azure-storage-blob/12.3.0-beta.1 (11.0.4; Windows 10 10.0)",
"x-ms-client-request-id" : "4ec131b7-b87e-454d-8341-e6cc0f870a61",
"Content-Type" : "application/xml; charset=utf-8"
},
"Response" : {
"x-ms-version" : "2019-02-02",
"Server" : "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"retry-after" : "0",
"Content-Length" : "0",
"StatusCode" : "202",
"x-ms-request-id" : "67fe4f12-f01e-002d-50cd-cb2148000000",
"Date" : "Wed, 15 Jan 2020 17:59:25 GMT",
"x-ms-client-request-id" : "4ec131b7-b87e-454d-8341-e6cc0f870a61"
},
"Exception" : null
}, {
"Method" : "GET",
"Uri" : "https://gaprastg71.blob.core.windows.net?prefix=jtcsetpropscorscheck&comp=list",
"Headers" : {
"x-ms-version" : "2019-02-02",
"User-Agent" : "azsdk-java-azure-storage-blob/12.3.0-beta.1 (11.0.4; Windows 10 10.0)",
"x-ms-client-request-id" : "916fd24d-7ccd-4225-a5e2-d4167b3bd8d6"
},
"Response" : {
"Transfer-Encoding" : "chunked",
"x-ms-version" : "2019-02-02",
"Server" : "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"Vary" : "Origin",
"retry-after" : "0",
"StatusCode" : "200",
"x-ms-request-id" : "67fe4f13-f01e-002d-51cd-cb2148000000",
"Body" : "<?xml version=\"1.0\" encoding=\"utf-8\"?><EnumerationResults ServiceEndpoint=\"https://gaprastg71.blob.core.windows.net/\"><Prefix>jtcsetpropscorscheck</Prefix><Containers><Container><Name>jtcsetpropscorscheck0serviceapitestsetpropscorscheckd2d100161</Name><Properties><Last-Modified>Wed, 15 Jan 2020 17:59:24 GMT</Last-Modified><Etag>\"0x8D799E4A7F4D6C3\"</Etag><LeaseStatus>unlocked</LeaseStatus><LeaseState>available</LeaseState><DefaultEncryptionScope>$account-encryption-key</DefaultEncryptionScope><DenyEncryptionScopeOverride>false</DenyEncryptionScopeOverride><HasImmutabilityPolicy>false</HasImmutabilityPolicy><HasLegalHold>false</HasLegalHold></Properties></Container></Containers><NextMarker /></EnumerationResults>",
"Date" : "Wed, 15 Jan 2020 17:59:25 GMT",
"x-ms-client-request-id" : "916fd24d-7ccd-4225-a5e2-d4167b3bd8d6",
"Content-Type" : "application/xml"
},
"Exception" : null
}, {
"Method" : "DELETE",
"Uri" : "https://gaprastg71.blob.core.windows.net/jtcsetpropscorscheck0serviceapitestsetpropscorscheckd2d100161?restype=container",
"Headers" : {
"x-ms-version" : "2019-02-02",
"User-Agent" : "azsdk-java-azure-storage-blob/12.3.0-beta.1 (11.0.4; Windows 10 10.0)",
"x-ms-client-request-id" : "a0d38f04-3502-44b0-a0de-5ff7662e7268"
},
"Response" : {
"x-ms-version" : "2019-02-02",
"Server" : "Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0",
"retry-after" : "0",
"Content-Length" : "0",
"StatusCode" : "202",
"x-ms-request-id" : "67fe4f14-f01e-002d-52cd-cb2148000000",
"Date" : "Wed, 15 Jan 2020 17:59:26 GMT",
"x-ms-client-request-id" : "a0d38f04-3502-44b0-a0de-5ff7662e7268"
},
"Exception" : null
} ],
"variables" : [ "jtcsetpropscorscheck0serviceapitestsetpropscorscheckd2d100161" ]
}
9 changes: 9 additions & 0 deletions ...torage-common/src/main/java/com/azure/storage/common/implementation/StorageImplUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,13 @@ public static String getAccountName(URL url) {
}
return accountName;
}

/**
* Returns an empty string if value is {@code null}, otherwise returns value
* @param value The value to check and return.
* @return The value or empty string.
*/
public static String emptyIfNull(String value) {
return value == null ? "" : value;
}
}