concordion/cubano

A packaged framework for implementing web and API test suites. Builds on Concordion to bring your software delivery team together around living documentation. http://concordion.org/cubano/framework

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.concordion:cubano:1.0.2'
	}

	dependencies {
		implementation("com.github.concordion:cubano:1.0.2")
	}

	<dependency>
	    <groupId>com.github.concordion</groupId>
	    <artifactId>cubano</artifactId>
	    <version>1.0.2</version>
	</dependency>


                            
    libraryDependencies += "com.github.concordion" % "cubano" % "1.0.2"


                            
    :dependencies [[com.github.concordion/cubano "1.0.2"]]

Readme

cubano

Cubano is a "ready-made" test framework that provides everything at your fingertips. It's ideal for software delivery teams who want to collaborate around living documentation.

Utilising Specification by Example techniques, the framework implements:

Web browser automation using Selenium WebDriver
API automation (REST / SOAP / HTTP)
Database automation

Cubano supplies User Documentation, and a Demo Project, to help users get started.

It encourages collaboration and communication between business people, testers and developers. The rich output presents multiple views of the specification with embedded storyboards and logs containing screenshots, HTML page source, message interactions and text.

The framework is easy to configure, for example supported browsers are simple to install locally using the Managed WebDriver, or in the cloud using SauceLabs or BrowserStack. It supports standard patterns for Page Objects and Components to provide the right level of abstraction for web pages.

It is built in Java using Concordion and incorporates numerous extensions.

Cubano Demo and Template Projects

Cubano provides a Demo Project, which contains information regarding

usage
documentation
working examples
and set up instructions

Once you are ready to start writing your own tests, pull down the Cubano Template Project and adapt this base to start automating your project.

Feedback

We love to receive feedback.

Please report any issues to this Github project.

Please post other feedback, questions and discussion to the Concordion Google Group with "[Cubano]" in the message header.

Contributing

All contributions are welcome, we do ask however that you follow our coding standards. This is rather easy as we have checkstyle and code formatter configuration files ready to use.

For eclipse:

Install findbugs plugin
Install checkstyle plugin
Eclipse > Preferences > Checkstyle > New...

Type: External configuration file Name: Cubano Location: <workspace>/cubano/config/checkstyle/checkstyle.xml
Eclipse > Preferences > Java > Code Style > Formatter > Import...

File: <workspace>/cubano/config/formatter/formatter.xml
Eclipse > Preferences > Java > Editor > Save Actions

Perform the selected actions on save: Checked Format source code: Format edited lines Organise imports: Checked
Eclipse > Project > Properties > Checkstyle

Checkstyle active for this project: Checked Use the following check configuration for all files: Cubano - (Global)

Releasing

The project is released to Maven Central using a few plugins defined in build.gradle.

<a name="Pre-conditions"></a>Pre-conditions

A GPG client is installed on your command line path. For more information, please refer to http://www.gnupg.org/.
You have created your GPG keys and distributed your public key. For more information, please refer to Gradle Signing Plugin.
You have a Sonatype JIRA account, which has approval for publishing to the Concordion project.
You have configured your gradle.properties, typically located in your ~/.gradle directory:

sonatypeUsername=<your-jira-username>
sonatypePassword=<your-jira-password>

signing.keyId=<public GPG key>
signing.password=<private GPG key passphrase>
signing.secretKeyRingFile=<path to secret key ring file containing your private key>

where <your-jira-username> and <your-jira-password> are the credentials for your Sonatype JIRA account.

Performing a release

Check that gradle.properties contains the desired version number.
Commit and push all the changes to GitHub. (The release plugin will fail if you have any changes that aren't committed and pushed.)
Checkout the master branch, if not already checked out.
Either run ./gradlew clean test javadoc gitPublishPush publishToSonatype closeSonatypeStagingRepository and manually release the build from the Nexus staging repository or run ./gradlew clean test javadoc gitPublishPush publishToSonatype closeAndReleaseSonatypeStagingRepository if you are confident. See the Gradle Nexus Publish Plugin for more details.
Create release notes on Github, selecting the version number of the release as the tag.

To build a local release and publish to your local Maven repository, you can run gradlew clean publishToMavenLocal.

Valued Partners

Thanks to Te Manatū Whakahiato Ora, the Ministry of Social Development, NZ for contributing this framework to the open source community.

Thanks also to Structure 101 for their software architecture visualisation tool - helping us keep the architecture in check.