Skip to content

Commit

Permalink
HSEARCH-3560 Rename configuration property 'hibernate.search.backend.…
Browse files Browse the repository at this point in the history
…aws.signing.region' to 'hibernate.search.backend.aws.region'

For consistency with credentials.
  • Loading branch information
yrodiere authored and fax4ever committed Sep 29, 2020
1 parent 60726cd commit c0ae769
Show file tree
Hide file tree
Showing 11 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -253,10 +253,10 @@ You will need to execute something along the lines of:
```bash
mvn clean install -Dtest.elasticsearch.connection.hosts=<host:port> \
-Dtest.elasticsearch.connection.aws.signing.enabled=true \
-Dtest.elasticsearch.connection.aws.region=<Your AWS region ID> \
-Dtest.elasticsearch.connection.aws.credentials.type=static \
-Dtest.elasticsearch.connection.aws.credentials.access_key_id=<Your access key ID> \
-Dtest.elasticsearch.connection.aws.credentials.secret_access_key=<Your secret access key> \
-Dtest.elasticsearch.connection.aws.signing.region=<Your AWS region ID>
-Dtest.elasticsearch.connection.aws.credentials.secret_access_key=<Your secret access key>
```

When building Hibernate Search with new JDKs,
Expand Down
2 changes: 1 addition & 1 deletion Jenkinsfile
Expand Up @@ -605,10 +605,10 @@ stage('Non-default environments') {
-Dtest.elasticsearch.connection.hosts=$buildEnv.endpointHostAndPort \
-Dtest.elasticsearch.connection.protocol=$buildEnv.endpointProtocol \
-Dtest.elasticsearch.connection.aws.signing.enabled=true \
-Dtest.elasticsearch.connection.aws.region=$buildEnv.awsRegion \
-Dtest.elasticsearch.connection.aws.credentials.type=static \
-Dtest.elasticsearch.connection.aws.credentials.access_key_id=$AWS_ACCESS_KEY_ID \
-Dtest.elasticsearch.connection.aws.credentials.secret_access_key=$AWS_SECRET_ACCESS_KEY \
-Dtest.elasticsearch.connection.aws.signing.region=$buildEnv.awsRegion \
"""
}
}
Expand Down
Expand Up @@ -34,7 +34,7 @@ private ElasticsearchAwsBackendSettings() {
* <p>
* No default: must be provided when signing is enabled.
*/
public static final String SIGNING_REGION = "aws.signing.region";
public static final String REGION = "aws.region";

/**
* The type of credentials to use when signing is {@link #SIGNING_ENABLED enabled}.
Expand Down
Expand Up @@ -36,7 +36,7 @@ public class ElasticsearchAwsHttpClientConfigurer implements ElasticsearchHttpCl
.build();

private static final OptionalConfigurationProperty<String> REGION =
ConfigurationProperty.forKey( ElasticsearchAwsBackendSettings.SIGNING_REGION )
ConfigurationProperty.forKey( ElasticsearchAwsBackendSettings.REGION )
.asString()
.build();

Expand Down
8 changes: 4 additions & 4 deletions documentation/src/test/resources/META-INF/persistence.xml
Expand Up @@ -73,14 +73,14 @@
value="${test.elasticsearch.connection.password}"/>
<property name="hibernate.search.backend.aws.signing.enabled"
value="${test.elasticsearch.connection.aws.signing.enabled}"/>
<property name="hibernate.search.backend.aws.region"
value="${test.elasticsearch.connection.aws.region}"/>
<property name="hibernate.search.backend.aws.credentials.type"
value="${test.elasticsearch.connection.aws.credentials.type}"/>
<property name="hibernate.search.backend.aws.credentials.access_key_id"
value="${test.elasticsearch.connection.aws.credentials.access_key_id}"/>
<property name="hibernate.search.backend.aws.credentials.secret_access_key"
value="${test.elasticsearch.connection.aws.credentials.secret_access_key}"/>
<property name="hibernate.search.backend.aws.signing.region"
value="${test.elasticsearch.connection.aws.signing.region}"/>
<!-- Make this test work even if there is only a single node in the cluster -->
<property name="hibernate.search.backend.schema_management.minimal_required_status"
value="yellow"/>
Expand Down Expand Up @@ -141,14 +141,14 @@
value="${test.elasticsearch.connection.password}"/>
<property name="hibernate.search.backend.aws.signing.enabled"
value="${test.elasticsearch.connection.aws.signing.enabled}"/>
<property name="hibernate.search.backend.aws.region"
value="${test.elasticsearch.connection.aws.region}"/>
<property name="hibernate.search.backend.aws.credentials.type"
value="${test.elasticsearch.connection.aws.credentials.type}"/>
<property name="hibernate.search.backend.aws.credentials.access_key_id"
value="${test.elasticsearch.connection.aws.credentials.access_key_id}"/>
<property name="hibernate.search.backend.aws.credentials.secret_access_key"
value="${test.elasticsearch.connection.aws.credentials.secret_access_key}"/>
<property name="hibernate.search.backend.aws.signing.region"
value="${test.elasticsearch.connection.aws.signing.region}"/>
<!-- Make this test work even if there is only a single node in the cluster -->
<property name="hibernate.search.backend.schema_management.minimal_required_status"
value="yellow"/>
Expand Down
Expand Up @@ -19,10 +19,10 @@ hibernate.search.backend.hosts = ${test.elasticsearch.connection.hosts}
hibernate.search.backend.username = ${test.elasticsearch.connection.username}
hibernate.search.backend.password = ${test.elasticsearch.connection.password}
hibernate.search.backend.aws.signing.enabled = ${test.elasticsearch.connection.aws.signing.enabled}
hibernate.search.backend.aws.region = ${test.elasticsearch.connection.aws.region}
hibernate.search.backend.aws.credentials.type = ${test.elasticsearch.connection.aws.credentials.type}
hibernate.search.backend.aws.credentials.access_key_id = ${test.elasticsearch.connection.aws.credentials.access_key_id}
hibernate.search.backend.aws.credentials.secret_access_key = ${test.elasticsearch.connection.aws.credentials.secret_access_key}
hibernate.search.backend.aws.signing.region = ${test.elasticsearch.connection.aws.signing.region}
hibernate.search.backend.log.json_pretty_printing = true
hibernate.search.backend.schema_management.minimal_required_status = yellow
hibernate.search.backend.analysis.configurer = org.hibernate.search.integrationtest.java.module.config.MyElasticsearchAnalysisConfigurer
2 changes: 1 addition & 1 deletion integrationtest/showcase/library/pom.xml
Expand Up @@ -131,10 +131,10 @@
<ELASTICSEARCH_USERNAME>${test.elasticsearch.connection.username}</ELASTICSEARCH_USERNAME>
<ELASTICSEARCH_PASSWORD>${test.elasticsearch.connection.password}</ELASTICSEARCH_PASSWORD>
<ELASTICSEARCH_AWS_SIGNING_ENABLED>${test.elasticsearch.connection.aws.signing.enabled}</ELASTICSEARCH_AWS_SIGNING_ENABLED>
<ELASTICSEARCH_AWS_REGION>${test.elasticsearch.connection.aws.region}</ELASTICSEARCH_AWS_REGION>
<ELASTICSEARCH_AWS_CREDENTIALS_TYPE>${test.elasticsearch.connection.aws.credentials.type}</ELASTICSEARCH_AWS_CREDENTIALS_TYPE>
<ELASTICSEARCH_AWS_CREDENTIALS_ACCESS_KEY_ID>${test.elasticsearch.connection.aws.credentials.access_key_id}</ELASTICSEARCH_AWS_CREDENTIALS_ACCESS_KEY_ID>
<ELASTICSEARCH_AWS_CREDENTIALS_SECRET_ACCESS_KEY>${test.elasticsearch.connection.aws.credentials.secret_access_key}</ELASTICSEARCH_AWS_CREDENTIALS_SECRET_ACCESS_KEY>
<ELASTICSEARCH_AWS_SIGNING_REGION>${test.elasticsearch.connection.aws.signing.region}</ELASTICSEARCH_AWS_SIGNING_REGION>
<!--
The test settings add a different suffix to this value for each test execution.
We can't add this suffix (${random.uuid}) here due to IDEA limitations:
Expand Down
Expand Up @@ -9,10 +9,10 @@ spring.jpa:
password: ${ELASTICSEARCH_PASSWORD} # From environment variable
aws:
signing.enabled: ${ELASTICSEARCH_AWS_SIGNING_ENABLED} # From environment variable
region: ${ELASTICSEARCH_AWS_REGION} # From environment variable
credentials:
type: ${ELASTICSEARCH_AWS_CREDENTIALS_TYPE}
access_key_id: ${ELASTICSEARCH_AWS_CREDENTIALS_ACCESS_KEY_ID} # From environment variable
secret_access_key: ${ELASTICSEARCH_AWS_CREDENTIALS_SECRET_ACCESS_KEY} # From environment variable
signing.region: ${ELASTICSEARCH_AWS_SIGNING_REGION} # From environment variable
discovery.enabled: true
analysis.configurer: elasticsearchAnalysisConfigurer
2 changes: 1 addition & 1 deletion jenkins/performance-elasticsearch.groovy
Expand Up @@ -104,10 +104,10 @@ lock(label: esAwsBuildEnv.lockedResourcesLabel) {
-jvmArgsAppend -Dhosts=$esAwsBuildEnv.endpointHostAndPort \
-jvmArgsAppend -Dprotocol=$esAwsBuildEnv.endpointProtocol \
-jvmArgsAppend -Daws.signing.enabled=true \
-jvmArgsAppend -Daws.region=$esAwsBuildEnv.awsRegion \
-jvmArgsAppend -Daws.credentials.type=static \
-jvmArgsAppend -Daws.credentials.access_key_id=$AWS_ACCESS_KEY_ID \
-jvmArgsAppend -Daws.credentials.secret_access_key=$AWS_SECRET_ACCESS_KEY \
-jvmArgsAppend -Daws.signing.region=$esAwsBuildEnv.awsRegion \
-e OnTheFlyIndexingBenchmarks.concurrentReadWrite \
-e OnTheFlyIndexingBenchmarks.query \
-wi 1 -i 10 \
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Expand Up @@ -463,10 +463,10 @@
<test.elasticsearch.connection.username></test.elasticsearch.connection.username>
<test.elasticsearch.connection.password></test.elasticsearch.connection.password>
<test.elasticsearch.connection.aws.signing.enabled>false</test.elasticsearch.connection.aws.signing.enabled>
<test.elasticsearch.connection.aws.region></test.elasticsearch.connection.aws.region>
<test.elasticsearch.connection.aws.credentials.type></test.elasticsearch.connection.aws.credentials.type>
<test.elasticsearch.connection.aws.credentials.access_key_id></test.elasticsearch.connection.aws.credentials.access_key_id>
<test.elasticsearch.connection.aws.credentials.secret_access_key></test.elasticsearch.connection.aws.credentials.secret_access_key>
<test.elasticsearch.connection.aws.signing.region></test.elasticsearch.connection.aws.signing.region>
<!-- Control how integration tests format the requests sent to Elasticsearch -->
<test.elasticsearch.testdialect></test.elasticsearch.testdialect>

Expand Down
Expand Up @@ -28,21 +28,21 @@ public static ElasticsearchTestHostConnectionConfiguration get() {
private final String username;
private final String password;
private final boolean awsSigningEnabled;
private final String awsRegion;
private final String awsCredentialsType;
private final String awsCredentialsAccessKeyId;
private final String awsCredentialsSecretAccessKey;
private final String awsSigningRegion;

private ElasticsearchTestHostConnectionConfiguration() {
this.hosts = System.getProperty( "test.elasticsearch.connection.hosts" );
this.protocol = System.getProperty( "test.elasticsearch.connection.protocol" );
this.username = System.getProperty( "test.elasticsearch.connection.username" );
this.password = System.getProperty( "test.elasticsearch.connection.password" );
this.awsSigningEnabled = Boolean.getBoolean( "test.elasticsearch.connection.aws.signing.enabled" );
this.awsRegion = System.getProperty( "test.elasticsearch.connection.aws.region" );
this.awsCredentialsType = System.getProperty( "test.elasticsearch.connection.aws.credentials.type" );
this.awsCredentialsAccessKeyId = System.getProperty( "test.elasticsearch.connection.aws.credentials.access_key_id" );
this.awsCredentialsSecretAccessKey = System.getProperty( "test.elasticsearch.connection.aws.credentials.secret_access_key" );
this.awsSigningRegion = System.getProperty( "test.elasticsearch.connection.aws.signing.region" );

log.infof(
"Integration tests will connect to '%s' using protocol '%s' (AWS signing enabled: '%s')",
Expand All @@ -56,9 +56,9 @@ public void addToBackendProperties(Map<String, ? super String> properties) {
properties.put( "username", username );
properties.put( "password", password );
properties.put( "aws.signing.enabled", String.valueOf( awsSigningEnabled ) );
properties.put( "aws.region", awsRegion );
properties.put( "aws.credentials.type", awsCredentialsType );
properties.put( "aws.credentials.access_key_id", awsCredentialsAccessKeyId );
properties.put( "aws.credentials.secret_access_key", awsCredentialsSecretAccessKey );
properties.put( "aws.signing.region", awsSigningRegion );
}
}

0 comments on commit c0ae769

Please sign in to comment.