Switch to gradle (#12)

Switch to gradle

Author: blen-desta

.gitignore

@@ -16,18 +16,14 @@ atlassian-ide-plugin.xml
 **/webapp/css/styles.css
 platform/solr/**/overlays
 
-# JMeter Related files to ignore
-jmeter.log
-*.jmx.log
-*.jtl
+.gradle
+**/build/
 
-# Maven Ignores (https://raw.githubusercontent.com/github/gitignore/master/Maven.gitignore)
-target/
-pom.xml.tag
-pom.xml.releaseBackup
-pom.xml.versionsBackup
-pom.xml.next
-release.properties
-dependency-reduced-pom.xml
-buildNumber.properties
-.mvn/timing.properties
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Cache of project
+.gradletasknamecache

README.md

@@ -9,76 +9,83 @@ SAML: https://wiki.oasis-open.org/security/FrontPage
 ECP: http://docs.oasis-open.org/security/saml/Post2.0/saml-ecp/v2.0/saml-ecp-v2.0.html
 
 ## Setup
-To build the project, execute `mvn clean install -nsu` at the project root.
-The `distribution` module will contain a full package of the deployment after the build.
-Tests can be run with the script:
-
-`<PATH_TO_PROJECT>/distribution/command-line/target/command-line-<VERSION>-bin/bin/samltest.sh`.
-
->NOTE
->
->In order for the test kit to execute properly, you must configure both
-the test kit's and your IdP's/SP's metadata, as well as implement plugins
+To build the project, execute `gradle build` at the project root.
+The `distribution/command-line` module will contain a full package of the deployment after the build.
+
+Tests can be run with the `samlconf` script under `<PATH_TO_PROJECT>/distribution/command-line/build/distributions/samlconf-<VERSION>/bin/`.
+
+The `samlconf` script takes multiple parameters:
+
+```
+NAME
+       samlconf - Runs the SAML Conformance Tests against an IdP or an SP
+
+SYNOPSIS
+       samlconf [-i path] [--idpMetadata path]
+           [-p path] [--plugins path] 
+
+DESCRIPTION
+       Runs the SAML Conformance Tests which tests the compliance of an IdP and/or an SP
+       with the SAML Specifications. If a compliance issue is identified, a 
+       SAMLConformanceException will be thrown with an explanation of the error and a direct
+       quote from the specification. All of the parameters are optional and if they are 
+       not provided, the default values will use DDF's parameters. All parameters must 
+       be given one time.
+
+OPTIONS
+       -i | --idpMetadata path
+           The path to the IdP metadata. If it is not given, the default IdP metadata
+           is /conf/idp-metadata.xml.
+           
+       -p | --plugins path
+            The path to the custom, server-specific plugin implementations. If it is not given, 
+            the default plugin directory is /plugins.
+```
+
+
+> NOTE
+> 
+> In order for the test kit to execute properly, you must configure both the test kit's and your IdP's/SP's metadata, as well as implement plugins
 for the user-handled portions of SAML profiles. See "Metadata" and "Plugins" for instructions.
 
 ### Metadata
 * If testing an IdP:
-  * **TODO** *This requires the user to rebuild and is not an optimal
-  configuration solution. A solution that works with a pre-built artifact
-  should be found.* Configure the test kit with your IdP's metadata by updating
-  `<PATH_TO_PROJECT>/distribution/command-line/src/main/resources/idp-metadata.xml`
-  prior to building.
-  * Configure your IdP with the test kit's metadata from
-  `<PATH_TO_PROJECT>/distribution/command-line/src/main/resources/test-sp-metadata.xml`.
+  * Provide your IdP's metadata file path to the `samlconf` script using `-i` or `--idpMetadata`.
+  * Configure your IdP with the test kit's SP metadata from
+  `<PATH_TO_PROJECT>/distribution/command-line/src/main/resources/test-sp-metadata.xml`
+  or `samlconf-1.0-SNAPSHOT/conf/test-sp-metadata.xml` from the distribution.
 
-* **TODO** If testing an SP:
-  * Place your SP's metadata into `sp-metadata.xml` under `<PATH_TO_PROJECT>/distribution/command-line/src/main/resources`.
-  * Copy `test-idp-metadata.xml` under `<PATH_TO_PROJECT>/distribution/command-line/src/main/resources` into your SP.
+* **TODO - not implemented yet** If testing an SP:
+  * Provide your SP's metadata file path to the `samlconf` script using `-s` or `--spMetadata`.
+  * Configure your SP with the test kit's IdP metadata from
+    `<PATH_TO_PROJECT>/distribution/command-line/src/main/resources/test-idp-metadata.xml`
+    or `samlconf-1.0-SNAPSHOT/conf/test-idp-metadata.xml` from the distribution.
 
 ### Plugins
 **TODO** *describe how to implement plugins*
 
-**TODO** *This requires the user to rebuild and is not an optimal configuration
-solution. A solution that works with a pre-built artifact should be found.*
-Place your plugins in `<PATH_TO_PROJECT>/distribution/command-line/target/command-line-<VERSION>-bin/plugins`.
+* Provide your plugins directory to the `samlconf` script using `-p` or `--plugins`.
 
 ### Docker
-To build a docker image, add `-P docker` to the build command. To run it, run:
-
-`docker run --rm -it -v <IDP_METADATA_PATH>:/samlconf/conf/idp-metadata.xml --add-host "<HOST_NAME>:<IP>" codice/samlconf`
-
-Where 
-* `<IDP_METADATA_PATH>` is the path to the file containing the idp's metadata
-(anywhere on your local machine ex: `/tmp/idp.xml`)
-* `<HOST_NAME>` is the hostname the IdP is running on (for DDF, DDF's hostname)
-* `<IP>` is the machine's IP address
+To build a docker image, execute `gradle build docker`. 
 
->NOTE
+> NOTE
 >
->To run the tests using the `docker-compose.yml` file, run `docker-compose up`
-in the `/docker` module.
-
->NOTE
->
->If building throws a `Connect to localhost:2375 [localhost/127.0.0.1, localhost/0:0:0:0:0:0:0:1] failed: Connection refused`
-error, go into docker settings &rarr; general &rarr; enable `Expose daemon to tcp://localhost:2375 without TLS`.
-
-### Running Tests in IDE
-
-Edit the run configuration of your tests to include the vm variables:
-
-* `-Dsaml.plugin.deployDir=<PATH_TO_PROJECT>/distribution/command-line/target/command-line-<VERSION>-bin/plugins`
-* `-Didp.metadata=<PATH_TO_PROJECT>/distribution/command-line/src/main/resources/idp-metadata.xml`
-* todo `-Didp.metadata=<PATH_TO_PROJECT>/distribution/command-line/src/main/resources/sp-metadata.xml`
+> Docker is used exclusively for our Jenkins builds.
 
 ## Steps to Test DDF's IDP
-* Boot up DDF
-* Copy the contents of `test-sp-metadata.xml` under `...saml-conformance/distribution/command-line/src/main/resources` to `AdminConsole -> Security -> Configuration -> IdPServer -> SP Metadata`.
-* If not on localhost, copy DDF's IDP metadata from `https://<hostname>:<port>/services/saml/sso/metadata` to `idp-metadata.xml` under `...saml-conformance/distribution/command-line/src/main/resources`.
-* Run the tests through your IDE by setting the vm variables (see "Running Tests in IDE") or by invoking the `...saml-conformance/distribution/command-line/target/command-line-\[VERSION\]-bin/bin/samltest.sh` script.
+* Start DDF
+* Copy the contents of `test-sp-metadata.xml` to `AdminConsole -> Security -> Configuration -> IdPServer -> SP Metadata`.
+* If not on localhost, copy DDF's IDP metadata from `https://<hostname>:<port>/services/idp/login/metadata` 
+to a file and pass that file to the `samlconf` script using `-i` or `--idpMetadata`.
+* Run `samlconf`.
 
 ## Steps to Test DDF's SP
-todo
+**TODO** * Start DDF
+* Copy the contents of `test-idp-metadata.xml` to `AdminConsole -> Security -> Configuration -> IdPClient -> IdP Metadata`.
+* If not on localhost, copy DDF's SP metadata from `https://<hostname>:<port>/services/saml/sso/metadata` 
+to a file and pass that file to the `samlconf` script using `-s` or `--spMetadata`.
+* Run `samlconf`.
 
 ## Project Structure
 This section will briefly talk about the project structure.
@@ -87,7 +94,7 @@ This section will briefly talk about the project structure.
 This module contains all the test related modules: `idp`, `sp`, and `common`.
 
 #### idp
-This module will contain all tests being written against a SAML IdP. The src directory of the module is organized by the SAML spec as follows:
+This module will contain all tests being written against a SAML IdP. The `src` directory of the module is organized by the SAML specification as follows:
 * Package: Based on Profile (i.e. WebSSO, Single Logout)
   * Class: Based on Binding (i.e. POST, REDIRECT, ARTIFACT)
 * Class: Based on Metadata
@@ -122,7 +129,8 @@ This module is the projects full package deployment consisting of: `command-line
 todo: check and elaborate on this&rarr; This module contains all the runtime elements including scripts, jars, and configurations.
 
 #### docker
-todo: check this&rarr; This module contains the logic for building a docker image.
+This module contains the logic for building a docker image.
+To build this module you must run the docker task by executing `gradle build docker`.
 
 #### suites
 This module contains the test suites.

build.gradle

@@ -0,0 +1,60 @@
+buildscript {
+    ext.kotlin_version='1.2.30'
+    ext.gradle_docker_version='3.2.4'
+
+    repositories {
+        jcenter()
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath "com.bmuschko:gradle-docker-plugin:$gradle_docker_version"
+    }
+}
+
+plugins {
+    id 'org.jetbrains.kotlin.jvm' version '1.2.30'
+}
+
+description = 'SAML Conformance Test Kit'
+
+project.ext {
+    project_version='1.0-SNAPSHOT'
+    kotlin_test_version='2.0.7'
+    rest_assured_version='2.9.0'
+    org_slf4j_version='1.7.1'
+    junit_version='4.12'
+    guava_version='24.0-jre'
+}
+
+allprojects {
+    group = 'org.codice.samlconf'
+    version = "$project_version"
+}
+
+subprojects {
+    apply plugin: 'java'
+    apply plugin: 'maven'
+    apply plugin: 'kotlin-kapt'
+    apply plugin: 'kotlin'
+    apply plugin: 'com.bmuschko.docker-remote-api'
+
+    sourceCompatibility = 1.8
+    targetCompatibility = 1.8
+
+    repositories {
+        mavenLocal()
+        mavenCentral()
+    }
+
+    dependencies {
+        compile "org.jetbrains.kotlin:kotlin-reflect"
+        compile "junit:junit:$junit_version"
+        compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
+        compile "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
+        compile "com.jayway.restassured:rest-assured:$rest_assured_version"
+        compile "org.slf4j:slf4j-api:$org_slf4j_version"
+        compile "com.google.guava:guava:$guava_version"
+    }
+}

distribution/command-line/build.gradle

@@ -0,0 +1,29 @@
+apply plugin: 'application'
+
+description = 'Script and CLI to run the tests.'
+
+group = 'org.codice.samlconf.distribution'
+
+applicationName = 'samlconf'
+
+mainClassName = 'org.codice.ckt.CommandKt'
+
+dependencies {
+    compile project(':plugins:ddf-plugins')
+    compile project(':library')
+    compile project(':plugins:plugins-api')
+    compile project(':test:common')
+    compile project(':test:idp')
+    compile project(':test:sp')
+    compile project(':distribution:suites')
+
+    compile 'us.jimschubert:kopper-typed:0.0.3'
+}
+
+applicationDistribution.from('src/main/resources/') {
+    into 'conf'
+}
+
+applicationDistribution.from(project(':plugins:ddf-plugins').file('build/libs')) {
+    into 'plugins'
+}