turcsanyip commented on a change in pull request #4369: URL: https://github.com/apache/nifi/pull/4369#discussion_r452307527
########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/services/azure/storage/ADLSCredentialsControllerService.java ########## @@ -0,0 +1,153 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.services.azure.storage; + +import com.google.common.base.Function; Review comment: Is Guava's `Function` used intentionally? ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/AbstractAzureDataLakeStorageProcessor.java ########## @@ -33,66 +33,26 @@ import org.apache.commons.lang3.StringUtils; import org.apache.nifi.components.PropertyDescriptor; -import org.apache.nifi.components.ValidationContext; -import org.apache.nifi.components.ValidationResult; import org.apache.nifi.components.Validator; import org.apache.nifi.context.PropertyContext; import org.apache.nifi.expression.ExpressionLanguageScope; import org.apache.nifi.flowfile.FlowFile; import org.apache.nifi.processor.AbstractProcessor; import org.apache.nifi.processor.Relationship; import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.services.azure.storage.ADLSCredentialsDetails; +import org.apache.nifi.services.azure.storage.ADLSCredentialsService; +import reactor.core.publisher.Mono; public abstract class AbstractAzureDataLakeStorageProcessor extends AbstractProcessor { - public static final PropertyDescriptor ACCOUNT_NAME = new PropertyDescriptor.Builder() - .name("storage-account-name").displayName("Storage Account Name") - .description("The storage account name. There are certain risks in allowing the account name to be stored as a flowfile " + - "attribute. While it does provide for a more flexible flow by allowing the account name to " + - "be fetched dynamically from a flowfile attribute, care must be taken to restrict access to " + - "the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). " + - "In addition, the provenance repositories may be put on encrypted disk partitions." + - " Instead of defining the Storage Account Name, Storage Account Key and SAS Token properties directly on the processor, " + - "the preferred way is to configure them through a controller service") - .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) - .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) - .required(true) - .sensitive(true).build(); - - public static final PropertyDescriptor ACCOUNT_KEY = new PropertyDescriptor.Builder() - .name("storage-account-key").displayName("Storage Account Key") - .description("The storage account key. This is an admin-like password providing access to every container in this account. It is recommended " + - "one uses Shared Access Signature (SAS) token instead for fine-grained control with policies. " + - "There are certain risks in allowing the account key to be stored as a flowfile " + - "attribute. While it does provide for a more flexible flow by allowing the account key to " + - "be fetched dynamically from a flow file attribute, care must be taken to restrict access to " + - "the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). " + - "In addition, the provenance repositories may be put on encrypted disk partitions.") - .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) - .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) - .required(false) - .sensitive(true).build(); - - public static final PropertyDescriptor SAS_TOKEN = new PropertyDescriptor.Builder() - .name("storage-sas-token").displayName("SAS Token") - .description("Shared Access Signature token, including the leading '?'. Specify either SAS Token (recommended) or Account Key. " + - "There are certain risks in allowing the SAS token to be stored as a flowfile " + - "attribute. While it does provide for a more flexible flow by allowing the account name to " + - "be fetched dynamically from a flowfile attribute, care must be taken to restrict access to " + - "the event provenance data (e.g. by strictly controlling the policies governing provenance for this Processor). " + - "In addition, the provenance repositories may be put on encrypted disk partitions.") - .required(false) - .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES) - .sensitive(true) - .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) - .build(); - - public static final PropertyDescriptor USE_MANAGED_IDENTITY = new PropertyDescriptor.Builder() - .name("use-managed-identity") - .displayName("Use Azure Managed Identity") - .description("Choose whether or not to use the managed identity of Azure VM/VMSS ") - .required(false).defaultValue("false").allowableValues("true", "false") - .addValidator(StandardValidators.BOOLEAN_VALIDATOR).build(); + public static final PropertyDescriptor CREDENTIALS_SERVICE = new PropertyDescriptor.Builder() + .name("adls-credentials-service") + .displayName("Azure Credentials") Review comment: I would rather call it "ADLS Credentials" on the UI which is more specific. ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/test/java/org/apache/nifi/services/azure/storage/TestADLSCredentialsControllerService.java ########## @@ -0,0 +1,242 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.services.azure.storage; + +import org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.util.NoOpProcessor; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.junit.Before; +import org.junit.Test; + +import java.util.HashMap; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; + +public class TestADLSCredentialsControllerService { + + public static final String CREDENTIALS_SERVICE_IDENTIIFIER = "credentials-service"; + + private static final String ACCOUNT_NAME_VALUE = "AccountName"; + private static final String ACCOUNT_KEY_VALUE = "AccountKey"; + private static final String SAS_TOKEN_VALUE = "SasToken"; + public static final String END_POINT_SUFFIX_VALUE = "end.point.suffix"; + + private TestRunner runner; + private ADLSCredentialsControllerService credentialsService; + + @Before + public void setUp() throws InitializationException { + runner = TestRunners.newTestRunner(NoOpProcessor.class); + credentialsService = new ADLSCredentialsControllerService(); + runner.addControllerService(CREDENTIALS_SERVICE_IDENTIIFIER, credentialsService); + } + + @Test + public void testNotValidBecauseAccountNameMissing() { + configureAccountKey(); + + runner.assertNotValid(credentialsService); + } + + @Test + public void testNotValidBecauseNoCredentialsIsSet() { + configureAccountName(); + + runner.assertNotValid(credentialsService); + } + + @Test + public void testNotValidBecauseBothAccountKeyAndSasTokenSpecified() { + configureAccountName(); + + configureAccountKey(); + configureSasToken(); + + runner.assertNotValid(credentialsService); + } + + @Test + public void testNotValidBecauseBothAccountKeyAndUseManagedIdentitySpecified() { + configureAccountName(); + + configureSasToken(); Review comment: Typo: configureAccountKey() ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/test/java/org/apache/nifi/processors/azure/storage/TestAbstractAzureDataLakeStorage.java ########## @@ -34,57 +36,20 @@ private TestRunner runner; @Before - public void setUp() { + public void setUp() throws Exception { // test the property validation in the abstract class via the put processor runner = TestRunners.newTestRunner(PutAzureDataLakeStorage.class); - runner.setProperty(ACCOUNT_NAME, "accountName"); - runner.setProperty(ACCOUNT_KEY, "accountKey"); + ControllerService credentialsService = mock(ControllerService.class, withSettings().extraInterfaces(ADLSCredentialsService.class)); Review comment: What is the difference between this and `mock(ADLSCredentialsService.class)` ? ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/test/java/org/apache/nifi/services/azure/storage/TestADLSCredentialsControllerService.java ########## @@ -0,0 +1,242 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.services.azure.storage; + +import org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.util.NoOpProcessor; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.junit.Before; +import org.junit.Test; + +import java.util.HashMap; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; + +public class TestADLSCredentialsControllerService { + + public static final String CREDENTIALS_SERVICE_IDENTIIFIER = "credentials-service"; Review comment: Typo: IDENTIFIER All the constants can be private. ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/test/java/org/apache/nifi/services/azure/storage/TestADLSCredentialsControllerService.java ########## @@ -0,0 +1,242 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.nifi.services.azure.storage; + +import org.apache.nifi.processors.azure.storage.utils.AzureStorageUtils; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.util.NoOpProcessor; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.junit.Before; +import org.junit.Test; + +import java.util.HashMap; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; + +public class TestADLSCredentialsControllerService { + + public static final String CREDENTIALS_SERVICE_IDENTIIFIER = "credentials-service"; + + private static final String ACCOUNT_NAME_VALUE = "AccountName"; + private static final String ACCOUNT_KEY_VALUE = "AccountKey"; + private static final String SAS_TOKEN_VALUE = "SasToken"; + public static final String END_POINT_SUFFIX_VALUE = "end.point.suffix"; + + private TestRunner runner; + private ADLSCredentialsControllerService credentialsService; + + @Before + public void setUp() throws InitializationException { + runner = TestRunners.newTestRunner(NoOpProcessor.class); + credentialsService = new ADLSCredentialsControllerService(); + runner.addControllerService(CREDENTIALS_SERVICE_IDENTIIFIER, credentialsService); + } + + @Test + public void testNotValidBecauseAccountNameMissing() { + configureAccountKey(); + + runner.assertNotValid(credentialsService); + } + + @Test + public void testNotValidBecauseNoCredentialsIsSet() { + configureAccountName(); + + runner.assertNotValid(credentialsService); + } + + @Test + public void testNotValidBecauseBothAccountKeyAndSasTokenSpecified() { + configureAccountName(); + + configureAccountKey(); + configureSasToken(); + + runner.assertNotValid(credentialsService); + } + + @Test + public void testNotValidBecauseBothAccountKeyAndUseManagedIdentitySpecified() { + configureAccountName(); + + configureSasToken(); + configureUseManagedIdentity(); + + runner.assertNotValid(credentialsService); + } + + @Test + public void testNotValidBecauseBothSasTokenAndUseManagedIdentitySpecified() { + configureAccountName(); + + configureAccountKey(); Review comment: Typo: configureSasToken() ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
