merge

CONTRIBUTING.md

@@ -22,8 +22,9 @@ Pull requests should be made against the master (development)
 branch and include relevant tests, if applicable. 
 
 Code should compile and tests should pass under all Java versions 
-which the OpenStack4j currently supports.  Currently we support
-a minimum version of Java 6.
+which the OpenStack4j currently supports.
+Refer to [unit tests README](./core-test/README.md) or [integration tests README](./core-integration-test/README.md) for more details on how to write tests.
+Currently we support a minimum version of Java 7.
 
 Please insure all code is formatted like the rest of the API, well documented and same patterns applied. When configuring your IDE workspace make sure tabs are represented as spaces.
 

Dockerfile

@@ -2,5 +2,10 @@ FROM maven:latest
 
 COPY . /usr/src/app
 WORKDIR /usr/src/app
+
+RUN useradd -m -u 1000 builder
+RUN chown -R builder /usr/src/app
+USER builder
+
 RUN mvn clean compile
 

Makefile

@@ -5,7 +5,7 @@
 
 GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
 IMAGE_NAME := openstack4j-dev$(if $(GIT_BRANCH),:$(GIT_BRANCH))
-DOCKER_RUN := docker run --rm -it --privileged $(IMAGE_NAME)
+DOCKER_RUN := docker run --rm -it --privileged -e MAVEN_CONFIG=/home/builder/.m2 $(IMAGE_NAME)
 
 default: build
 
@@ -21,4 +21,4 @@ package: build
 	$(DOCKER_RUN) mvn clean package
 
 build:
-	docker build -t "$(IMAGE_NAME)" .
+	docker build -t "$(IMAGE_NAME)" .

README.md

@@ -38,7 +38,7 @@ OpenStack4j version 2.0.0+ is now modular.  One of the benefits to this is the a
 <dependency>
     <groupId>org.pacesys</groupId>
     <artifactId>openstack4j</artifactId>
-    <version>3.0.3</version>
+    <version>3.0.4</version>
 </dependency>
 ```
 
@@ -54,7 +54,7 @@ See notes above about connectors (same rules apply) to development branches.
 <dependency>
     <groupId>org.pacesys</groupId>
     <artifactId>openstack4j</artifactId>
-    <version>3.0.4-SNAPSHOT</version>
+    <version>3.0.5-SNAPSHOT</version>
 </dependency>
 ```
 
@@ -177,6 +177,35 @@ OSClientV3 os = OSFactory.builderV3()
                 .scopeToProject(Identifier.byId("project id"))
                 .authenticate());
 ```
+(5) authenticate using client certificate
+```bash
+openssl pkcs12 -export -out client-certificate-keystore.p12  -inkey key.pem -in cert.pem -certfile ca.pem
+Enter Export Password:encrypt
+Verifying - Enter Export Password:encrypt
+```
+```java
+String encrypt =  "encrypt";
+KeyStore keyStore = KeyStore.getInstance("PKCS12");
+keyStore.load(new FileInputStream(new File("client-certificate-keystore.p12")), encrypt.toCharArray());
+SSLContext sslContext = SSLContexts.custom()
+        //ignore server verify
+        .loadTrustMaterial(new TrustStrategy() {
+            @Override
+            public boolean isTrusted(X509Certificate[] chain, String authType) throws CertificateException {
+                return true;
+            }
+        })
+        .loadKeyMaterial(keyStore,encrypt.toCharArray())
+        .build();
+Config config = Config.newConfig();
+config.withSSLContext(sslContext);
+OSClient.OSClientV3 osClient = OSFactory.builderV3()
+        .endpoint("https://<fqdn>:5000/v3")
+        .withConfig(config)
+        .scopeToProject(Identifier.byId("project id"))
+        //.scopeToDomain(Identifier.byId("domain id"))
+        .authenticate();
+```
 
 #### Identity Operations (Keystone) V3
 

connectors/http-connector/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.pacesys.openstack4j.connectors</groupId>
         <artifactId>openstack4j-connectors</artifactId>
-        <version>3.0.4-SNAPSHOT</version>
+        <version>3.0.5-SNAPSHOT</version>
     </parent>
     <name>OpenStack4j HttpURL Connector</name>
     <artifactId>openstack4j-http-connector</artifactId>

connectors/httpclient/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>org.pacesys.openstack4j.connectors</groupId>
 		<artifactId>openstack4j-connectors</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>openstack4j-httpclient</artifactId>

connectors/jersey2/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>org.pacesys.openstack4j.connectors</groupId>
 		<artifactId>openstack4j-connectors</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>openstack4j-jersey2</artifactId>

connectors/okhttp/pom.xml

@@ -2,7 +2,7 @@
     <parent>
         <groupId>org.pacesys.openstack4j.connectors</groupId>
         <artifactId>openstack4j-connectors</artifactId>
-        <version>3.0.4-SNAPSHOT</version>
+        <version>3.0.5-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>openstack4j-okhttp</artifactId>

connectors/pom.xml

@@ -2,7 +2,7 @@
     <parent>
         <groupId>org.pacesys</groupId>
         <artifactId>openstack4j-parent</artifactId>
-        <version>3.0.4-SNAPSHOT</version>
+        <version>3.0.5-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.pacesys.openstack4j.connectors</groupId>

connectors/resteasy/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>org.pacesys.openstack4j.connectors</groupId>
 		<artifactId>openstack4j-connectors</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>openstack4j-resteasy</artifactId>

core-integration-test/it-httpclient/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>org.pacesys</groupId>
 		<artifactId>openstack4j-core-integration-test</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<artifactId>it-httpclient</artifactId>
 	<name>OpenStack4j IntegrationTest Apache HttpClient</name>

core-integration-test/it-jersey2/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>org.pacesys</groupId>
 		<artifactId>openstack4j-core-integration-test</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<artifactId>it-jersey2</artifactId>
 	<name>OpenStack4j IntegrationTest Jersey2 Connector</name>

core-integration-test/it-okhttp/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>org.pacesys</groupId>
 		<artifactId>openstack4j-core-integration-test</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<artifactId>it-okhttp</artifactId>
 	<name>OpenStack4j IntegrationTest OKHttp Connector</name>

core-integration-test/it-resteasy/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>org.pacesys</groupId>
 		<artifactId>openstack4j-core-integration-test</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<artifactId>it-resteasy</artifactId>
 	<name>OpenStack4j IntegrationTest RestEasy Connector</name>

core-integration-test/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>org.pacesys</groupId>
 		<artifactId>openstack4j-parent</artifactId>
-		<version>3.0.4-SNAPSHOT</version>
+		<version>3.0.5-SNAPSHOT</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>openstack4j-core-integration-test</artifactId>

core-integration-test/src/test/groovy/org/openstack4j/api/dns/v2/DesignateRecordsetServiceSpec.groovy

@@ -0,0 +1,161 @@
+/*
+package org.openstack4j.api.dns.v2
+
+import co.freeside.betamax.TapeMode
+import groovy.util.logging.Slf4j
+import org.junit.Rule
+import org.junit.rules.TestName
+import org.openstack4j.api.AbstractSpec
+import org.openstack4j.api.Builders
+import org.openstack4j.api.OSClient.OSClientV3
+import org.openstack4j.model.common.ActionResponse
+import org.openstack4j.model.common.Identifier
+import org.openstack4j.model.dns.v2.Recordset
+import org.openstack4j.openstack.OSFactory
+import software.betamax.Configuration
+import software.betamax.MatchRules
+import software.betamax.TapeMode
+import software.betamax.junit.Betamax
+import software.betamax.junit.RecorderRule
+import spock.lang.IgnoreIf
+
+@Slf4j
+class DesignateRecordsetServiceSpec extends AbstractSpec {
+
+    @Rule TestName DesignateRecordsetServiceTest
+    @Rule public RecorderRule recorderRule = new RecorderRule(
+            Configuration.builder()
+                    .tapeRoot(new File(TAPEROOT + "identity.v3"))
+                    //.defaultMatchRules(MatchRules.method, MatchRules.path, MatchRules.queryParams)
+                    .defaultMode(TapeMode.WRITE_SEQUENTIAL)
+                    .build());
+
+    // used for domain crud tests
+    def static final String RECORDSET_NAME = "Atest."
+    def static final String RECORDSET_TYPE = "A"
+    def static final List<String> RECORDSET_RECORDS= ["10.1.0.2"]
+    def static final String RECORDSET_DESCRIPTION = "This is my recordset."
+    def String ZONE_ID, ZONE_NAME, RECORDSET_ID
+
+    static final boolean skipTest
+
+    static {
+        if(
+        USER_ID == null ||
+                AUTH_URL == null ||
+                PASSWORD == null ||
+                DOMAIN_ID == null ) {
+
+            skipTest = true
+        }
+        else{
+            skipTest = false
+        }
+    }
+
+
+    // run before the first feature method; similar to JUnit's @BeforeClass
+    def setupSpec() {
+
+        if( skipTest != true ) {
+            log.info("USER_NAME: " + USER_NAME)
+            log.info("USER_DOMAIN_ID: " + USER_DOMAIN_ID)
+            log.info("AUTH_URL: " + AUTH_URL)
+            log.info("PROJECT_ID: " + PROJECT_ID)
+        }
+        else {
+            log.warn("Skipping integration-test cases because not all mandatory attributes are set.");
+        }
+    }
+
+    def setup() {
+        log.info("-> Test: '$DesignateRecordsetServiceTest.methodName'")
+    }
+
+
+    // ------------ DomainService Tests ------------
+
+    @IgnoreIf({ skipTest })
+    @Betamax(tape="recordsetService_crud")
+    def "dns/v2/recordset test cases"() {
+
+        given: "an authenticated OSClient"
+        OSClientV3 os = OSFactory.builderV3()
+                .endpoint(AUTH_URL)
+                .credentials(USER_NAME, PASSWORD, Identifier.byId(USER_DOMAIN_ID))
+                .scopeToProject(Identifier.byId(PROJECT_ID))
+                .withConfig(CONFIG_PROXY_BETAMAX)
+                .authenticate()
+
+        and: "get the id of a dns zone"
+        ZONE_ID = os.dns().zones().list().first().getId()
+
+        and: "the id of the zone shouldn't be null"
+        ZONE_ID != null
+
+        and: "get name of the zone"
+        ZONE_NAME = os.dns().zones().list().first().getName()
+
+        and: "the name of the zone shouldn't be null"
+        ZONE_NAME != null
+
+        when: "we try to create a recordset with argument 'null' "
+        os.dns().recordsets().create(null, null)
+
+        then: "a NPE is thrown"
+        thrown NullPointerException
+
+        when: "creating a recordset"
+        Recordset recordset = os.dns().recordsets().create(ZONE_ID, RECORDSET_NAME+ZONE_NAME, RECORDSET_TYPE, RECORDSET_RECORDS)
+
+        then: "the attributes of the recordset should be equal"
+        recordset.getName() == RECORDSET_NAME+ZONE_NAME
+        recordset.getZoneId() == ZONE_ID
+        recordset.getType() == RECORDSET_TYPE
+        recordset.getRecords() == RECORDSET_RECORDS
+
+        when: "getting the id of the recordset"
+        RECORDSET_ID = recordset.getId()
+
+        then: "this shouldn't be null"
+        RECORDSET_ID != null
+
+        when: "list recordsets owned by project"
+        List<? extends Recordset> recordsetList = os.dns().recordsets().list()
+
+        then: "the list shouldn't be empty and the recordset belongs to the project"
+        recordsetList.isEmpty() == false
+        recordsetList.first().getProjectId() == PROJECT_ID
+
+        when: "list recordsets in a zone"
+        List<? extends Recordset> recordsetListZone = os.dns().recordsets().list(ZONE_ID)
+
+        then: "the list shouldn't be empty and the recordset is within the zone"
+        recordsetListZone.isEmpty() == false
+        recordsetListZone.first().getZoneId() == ZONE_ID
+
+        when: "get a recordset by id"
+        Recordset recordsetById = os.dns().recordsets().get(ZONE_ID,RECORDSET_ID)
+
+        then: "the attributes of the recordset should be equal"
+        recordsetById.getZoneId() == ZONE_ID
+        recordsetById.getId() == RECORDSET_ID
+
+        when: "updating a recordset"
+        Recordset recordsetUpdated = os.dns().recordsets().update(ZONE_ID, Builders.recordset().id(RECORDSET_ID).description(RECORDSET_DESCRIPTION).build())
+
+        then: "the attribute of the recordset should be updated"
+        recordsetUpdated.getDescription() == RECORDSET_DESCRIPTION
+
+        when: "deleting a recordset"
+        ActionResponse deleteRecordset = os.dns().recordsets().delete(ZONE_ID,RECORDSET_ID)
+
+        then: "this should be successful"
+        deleteRecordset.isSuccess() == true
+
+        cleanup: "delete created recordset in case of errors"
+        os.dns().recordsets().delete(ZONE_ID,RECORDSET_ID)
+
+    }
+}
+*/