661 lines
26 KiB
HTML
661 lines
26 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="Asciidoctor 1.5.7.1">
|
||
<title>Spring Cloud Contract</title>
|
||
<link rel="stylesheet" href="css/spring.css">
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
|
||
|
||
<style>
|
||
.hidden {
|
||
display: none;
|
||
}
|
||
|
||
.switch {
|
||
border-width: 1px 1px 0 1px;
|
||
border-style: solid;
|
||
border-color: #7a2518;
|
||
display: inline-block;
|
||
}
|
||
|
||
.switch--item {
|
||
padding: 10px;
|
||
background-color: #ffffff;
|
||
color: #7a2518;
|
||
display: inline-block;
|
||
cursor: pointer;
|
||
}
|
||
|
||
.switch--item:not(:first-child) {
|
||
border-width: 0 0 0 1px;
|
||
border-style: solid;
|
||
border-color: #7a2518;
|
||
}
|
||
|
||
.switch--item.selected {
|
||
background-color: #7a2519;
|
||
color: #ffffff;
|
||
}
|
||
</style>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js"></script>
|
||
<script type="text/javascript">
|
||
function addBlockSwitches() {
|
||
$('.primary').each(function() {
|
||
primary = $(this);
|
||
createSwitchItem(primary, createBlockSwitch(primary)).item.addClass("selected");
|
||
primary.children('.title').remove();
|
||
});
|
||
$('.secondary').each(function(idx, node) {
|
||
secondary = $(node);
|
||
primary = findPrimary(secondary);
|
||
switchItem = createSwitchItem(secondary, primary.children('.switch'));
|
||
switchItem.content.addClass('hidden');
|
||
findPrimary(secondary).append(switchItem.content);
|
||
secondary.remove();
|
||
});
|
||
}
|
||
|
||
function createBlockSwitch(primary) {
|
||
blockSwitch = $('<div class="switch"></div>');
|
||
primary.prepend(blockSwitch);
|
||
return blockSwitch;
|
||
}
|
||
|
||
function findPrimary(secondary) {
|
||
candidate = secondary.prev();
|
||
while (!candidate.is('.primary')) {
|
||
candidate = candidate.prev();
|
||
}
|
||
return candidate;
|
||
}
|
||
|
||
function createSwitchItem(block, blockSwitch) {
|
||
blockName = block.children('.title').text();
|
||
content = block.children('.content').first().append(block.next('.colist'));
|
||
item = $('<div class="switch--item">' + blockName + '</div>');
|
||
item.on('click', '', content, function(e) {
|
||
$(this).addClass('selected');
|
||
$(this).siblings().removeClass('selected');
|
||
e.data.siblings('.content').addClass('hidden');
|
||
e.data.removeClass('hidden');
|
||
});
|
||
blockSwitch.append(item);
|
||
return {'item': item, 'content': content};
|
||
}
|
||
|
||
$(addBlockSwitches);
|
||
</script>
|
||
|
||
</head>
|
||
<body class="book toc2 toc-left">
|
||
<div id="header">
|
||
<div id="toc" class="toc2">
|
||
<div id="toctitle">Table of Contents</div>
|
||
<ul class="sectlevel1">
|
||
<li><a href="#_spring_cloud_contract">Spring Cloud Contract</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_spring_cloud_contract_workshops">Spring Cloud Contract workshops</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_project_page">Project page</a></li>
|
||
<li><a href="#_contributing">Contributing</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_sign_the_contributor_license_agreement">Sign the Contributor License Agreement</a></li>
|
||
<li><a href="#_code_of_conduct">Code of Conduct</a></li>
|
||
<li><a href="#_code_conventions_and_housekeeping">Code Conventions and Housekeeping</a></li>
|
||
<li><a href="#_checkstyle">Checkstyle</a></li>
|
||
<li><a href="#_ide_setup">IDE setup</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_how_to_build_spring_cloud_contract">How to Build Spring Cloud Contract</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_project_structure">Project structure</a></li>
|
||
<li><a href="#_commands">Commands</a></li>
|
||
<li><a href="#_helpful_scripts">Helpful scripts</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div id="content">
|
||
<div class="sect1">
|
||
<h2 id="_spring_cloud_contract"><a class="link" href="#_spring_cloud_contract">Spring Cloud Contract</a></h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>You always need confidence when pushing new features into a new application or service in
|
||
a distributed system. To that end, this project provides support for consumer-driven
|
||
contracts and service schemas in Spring applications, covering a range of options for
|
||
writing tests, publishing them as assets, and asserting that a contract is kept by
|
||
producers and consumers — for both HTTP and message-based interactions.</p>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_spring_cloud_contract_workshops"><a class="link" href="#_spring_cloud_contract_workshops">Spring Cloud Contract workshops</a></h3>
|
||
<div class="paragraph">
|
||
<p>If you prefer to learn about the project by doing some tutorials, you can check out the
|
||
workshops under
|
||
<a href="https://cloud-samples.spring.io/spring-cloud-contract-samples/workshops.html">this link</a>.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_project_page"><a class="link" href="#_project_page">Project page</a></h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>You can read more about Spring Cloud Contract by going to <a href="https://spring.io/projects/spring-cloud-contract">the project page</a></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_contributing"><a class="link" href="#_contributing">Contributing</a></h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>Spring Cloud is released under the non-restrictive Apache 2.0 license,
|
||
and follows a very standard Github development process, using Github
|
||
tracker for issues and merging pull requests into master. If you want
|
||
to contribute even something trivial please do not hesitate, but
|
||
follow the guidelines below.</p>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_sign_the_contributor_license_agreement"><a class="link" href="#_sign_the_contributor_license_agreement">Sign the Contributor License Agreement</a></h3>
|
||
<div class="paragraph">
|
||
<p>Before we accept a non-trivial patch or pull request we will need you to sign the
|
||
<a href="https://cla.pivotal.io/sign/spring">Contributor License Agreement</a>.
|
||
Signing the contributor’s agreement does not grant anyone commit rights to the main
|
||
repository, but it does mean that we can accept your contributions, and you will get an
|
||
author credit if we do. Active contributors might be asked to join the core team, and
|
||
given the ability to merge pull requests.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_code_of_conduct"><a class="link" href="#_code_of_conduct">Code of Conduct</a></h3>
|
||
<div class="paragraph">
|
||
<p>This project adheres to the Contributor Covenant <a href="https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc">code of
|
||
conduct</a>. By participating, you are expected to uphold this code. Please report
|
||
unacceptable behavior to <a href="mailto:spring-code-of-conduct@pivotal.io">spring-code-of-conduct@pivotal.io</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_code_conventions_and_housekeeping"><a class="link" href="#_code_conventions_and_housekeeping">Code Conventions and Housekeeping</a></h3>
|
||
<div class="paragraph">
|
||
<p>None of these is essential for a pull request, but they will all help. They can also be
|
||
added after the original pull request but before a merge.</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>Use the Spring Framework code format conventions. If you use Eclipse
|
||
you can import formatter settings using the
|
||
<code>eclipse-code-formatter.xml</code> file from the
|
||
<a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml">Spring
|
||
Cloud Build</a> project. If using IntelliJ, you can use the
|
||
<a href="https://plugins.jetbrains.com/plugin/6546">Eclipse Code Formatter
|
||
Plugin</a> to import the same file.</p>
|
||
</li>
|
||
<li>
|
||
<p>Make sure all new <code>.java</code> files to have a simple Javadoc class comment with at least an
|
||
<code>@author</code> tag identifying you, and preferably at least a paragraph on what the class is
|
||
for.</p>
|
||
</li>
|
||
<li>
|
||
<p>Add the ASF license header comment to all new <code>.java</code> files (copy from existing files
|
||
in the project)</p>
|
||
</li>
|
||
<li>
|
||
<p>Add yourself as an <code>@author</code> to the .java files that you modify substantially (more
|
||
than cosmetic changes).</p>
|
||
</li>
|
||
<li>
|
||
<p>Add some Javadocs and, if you change the namespace, some XSD doc elements.</p>
|
||
</li>
|
||
<li>
|
||
<p>A few unit tests would help a lot as well — someone has to do it.</p>
|
||
</li>
|
||
<li>
|
||
<p>If no-one else is using your branch, please rebase it against the current master (or
|
||
other target branch in the main project).</p>
|
||
</li>
|
||
<li>
|
||
<p>When writing a commit message please follow <a href="https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">these conventions</a>,
|
||
if you are fixing an existing issue please add <code>Fixes gh-XXXX</code> at the end of the commit
|
||
message (where XXXX is the issue number).</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_checkstyle"><a class="link" href="#_checkstyle">Checkstyle</a></h3>
|
||
<div class="paragraph">
|
||
<p>Spring Cloud Build comes with a set of checkstyle rules. You can find them in the <code>spring-cloud-build-tools</code> module. The most notable files under the module are:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="title">spring-cloud-build-tools/</div>
|
||
<div class="content">
|
||
<pre>└── src
|
||
├── checkstyle
|
||
│ └── checkstyle-suppressions.xml <i class="conum" data-value="3"></i><b>(3)</b>
|
||
└── main
|
||
└── resources
|
||
├── checkstyle-header.txt <i class="conum" data-value="2"></i><b>(2)</b>
|
||
└── checkstyle.xml <i class="conum" data-value="1"></i><b>(1)</b></pre>
|
||
</div>
|
||
</div>
|
||
<div class="colist arabic">
|
||
<table>
|
||
<tr>
|
||
<td><i class="conum" data-value="1"></i><b>1</b></td>
|
||
<td>Default Checkstyle rules</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="2"></i><b>2</b></td>
|
||
<td>File header setup</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="3"></i><b>3</b></td>
|
||
<td>Default suppression rules</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_checkstyle_configuration"><a class="link" href="#_checkstyle_configuration">Checkstyle configuration</a></h4>
|
||
<div class="paragraph">
|
||
<p>Checkstyle rules are <strong>disabled by default</strong>. To add checkstyle to your project just define the following properties and plugins.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="title">pom.xml</div>
|
||
<div class="content">
|
||
<pre><properties>
|
||
<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError> <i class="conum" data-value="1"></i><b>(1)</b>
|
||
<maven-checkstyle-plugin.failsOnViolation>true
|
||
</maven-checkstyle-plugin.failsOnViolation> <i class="conum" data-value="2"></i><b>(2)</b>
|
||
<maven-checkstyle-plugin.includeTestSourceDirectory>true
|
||
</maven-checkstyle-plugin.includeTestSourceDirectory> <i class="conum" data-value="3"></i><b>(3)</b>
|
||
</properties>
|
||
|
||
<build>
|
||
<plugins>
|
||
<plugin> <i class="conum" data-value="4"></i><b>(4)</b>
|
||
<groupId>io.spring.javaformat</groupId>
|
||
<artifactId>spring-javaformat-maven-plugin</artifactId>
|
||
</plugin>
|
||
<plugin> <i class="conum" data-value="5"></i><b>(5)</b>
|
||
<groupId>org.apache.maven.plugins</groupId>
|
||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||
</plugin>
|
||
</plugins>
|
||
|
||
<reporting>
|
||
<plugins>
|
||
<plugin> <i class="conum" data-value="5"></i><b>(5)</b>
|
||
<groupId>org.apache.maven.plugins</groupId>
|
||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||
</plugin>
|
||
</plugins>
|
||
</reporting>
|
||
</build></pre>
|
||
</div>
|
||
</div>
|
||
<div class="colist arabic">
|
||
<table>
|
||
<tr>
|
||
<td><i class="conum" data-value="1"></i><b>1</b></td>
|
||
<td>Fails the build upon Checkstyle errors</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="2"></i><b>2</b></td>
|
||
<td>Fails the build upon Checkstyle violations</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="3"></i><b>3</b></td>
|
||
<td>Checkstyle analyzes also the test sources</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="4"></i><b>4</b></td>
|
||
<td>Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="5"></i><b>5</b></td>
|
||
<td>Add checkstyle plugin to your build and reporting phases</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>If you need to suppress some rules (e.g. line length needs to be longer), then it’s enough for you to define a file under <code>${project.root}/src/checkstyle/checkstyle-suppressions.xml</code> with your suppressions. Example:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="title">projectRoot/src/checkstyle/checkstyle-suppresions.xml</div>
|
||
<div class="content">
|
||
<pre><?xml version="1.0"?>
|
||
<!DOCTYPE suppressions PUBLIC
|
||
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
|
||
"https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
||
<suppressions>
|
||
<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
|
||
<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
|
||
</suppressions></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>It’s advisable to copy the <code>${spring-cloud-build.rootFolder}/.editorconfig</code> and <code>${spring-cloud-build.rootFolder}/.springformat</code> to your project. That way, some default formatting rules will be applied. You can do so by running this script:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
|
||
$ touch .springformat</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_ide_setup"><a class="link" href="#_ide_setup">IDE setup</a></h3>
|
||
<div class="sect3">
|
||
<h4 id="_intellij_idea"><a class="link" href="#_intellij_idea">Intellij IDEA</a></h4>
|
||
<div class="paragraph">
|
||
<p>In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
|
||
The following files can be found in the <a href="https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools">Spring Cloud Build</a> project.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="title">spring-cloud-build-tools/</div>
|
||
<div class="content">
|
||
<pre>└── src
|
||
├── checkstyle
|
||
│ └── checkstyle-suppressions.xml <i class="conum" data-value="3"></i><b>(3)</b>
|
||
└── main
|
||
└── resources
|
||
├── checkstyle-header.txt <i class="conum" data-value="2"></i><b>(2)</b>
|
||
├── checkstyle.xml <i class="conum" data-value="1"></i><b>(1)</b>
|
||
└── intellij
|
||
├── Intellij_Project_Defaults.xml <i class="conum" data-value="4"></i><b>(4)</b>
|
||
└── Intellij_Spring_Boot_Java_Conventions.xml <i class="conum" data-value="5"></i><b>(5)</b></pre>
|
||
</div>
|
||
</div>
|
||
<div class="colist arabic">
|
||
<table>
|
||
<tr>
|
||
<td><i class="conum" data-value="1"></i><b>1</b></td>
|
||
<td>Default Checkstyle rules</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="2"></i><b>2</b></td>
|
||
<td>File header setup</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="3"></i><b>3</b></td>
|
||
<td>Default suppression rules</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="4"></i><b>4</b></td>
|
||
<td>Project defaults for Intellij that apply most of Checkstyle rules</td>
|
||
</tr>
|
||
<tr>
|
||
<td><i class="conum" data-value="5"></i><b>5</b></td>
|
||
<td>Project style conventions for Intellij that apply most of Checkstyle rules</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="imageblock">
|
||
<div class="content">
|
||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/images/intellij-code-style.png" alt="Code style">
|
||
</div>
|
||
<div class="title">Figure 1. Code style</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Go to <code>File</code> → <code>Settings</code> → <code>Editor</code> → <code>Code style</code>. There click on the icon next to the <code>Scheme</code> section. There, click on the <code>Import Scheme</code> value and pick the <code>Intellij IDEA code style XML</code> option. Import the <code>spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml</code> file.</p>
|
||
</div>
|
||
<div class="imageblock">
|
||
<div class="content">
|
||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/images/intellij-inspections.png" alt="Code style">
|
||
</div>
|
||
<div class="title">Figure 2. Inspection profiles</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Go to <code>File</code> → <code>Settings</code> → <code>Editor</code> → <code>Inspections</code>. There click on the icon next to the <code>Profile</code> section. There, click on the <code>Import Profile</code> and import the <code>spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml</code> file.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<div class="title">Checkstyle</div>
|
||
<p>To have Intellij work with Checkstyle, you have to install the <code>Checkstyle</code> plugin. It’s advisable to also install the <code>Assertions2Assertj</code> to automatically convert the JUnit assertions</p>
|
||
</div>
|
||
<div class="imageblock">
|
||
<div class="content">
|
||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/images/intellij-checkstyle.png" alt="Checkstyle">
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Go to <code>File</code> → <code>Settings</code> → <code>Other settings</code> → <code>Checkstyle</code>. There click on the <code>+</code> icon in the <code>Configuration file</code> section. There, you’ll have to define where the checkstyle rules should be picked from. In the image above, we’ve picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build’s GitHub repository (e.g. for the <code>checkstyle.xml</code> : <code><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml" class="bare">https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml</a></code>). We need to provide the following variables:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>checkstyle.header.file</code> - please point it to the Spring Cloud Build’s, <code>spring-cloud-build-tools/src/main/resources/checkstyle-header.txt</code> file either in your cloned repo or via the <code><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt" class="bare">https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt</a></code> URL.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>checkstyle.suppressions.file</code> - default suppressions. Please point it to the Spring Cloud Build’s, <code>spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml</code> file either in your cloned repo or via the <code><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml" class="bare">https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml</a></code> URL.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>checkstyle.additional.suppressions.file</code> - this variable corresponds to suppressions in your local project. E.g. you’re working on <code>spring-cloud-contract</code>. Then point to the <code>project-root/src/checkstyle/checkstyle-suppressions.xml</code> folder. Example for <code>spring-cloud-contract</code> would be: <code>/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml</code>.</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="admonitionblock important">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<i class="fa icon-important" title="Important"></i>
|
||
</td>
|
||
<td class="content">
|
||
Remember to set the <code>Scan Scope</code> to <code>All sources</code> since we apply checkstyle rules for production and test sources.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_how_to_build_spring_cloud_contract"><a class="link" href="#_how_to_build_spring_cloud_contract">How to Build Spring Cloud Contract</a></h2>
|
||
<div class="sectionbody">
|
||
<div class="admonitionblock important">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<i class="fa icon-important" title="Important"></i>
|
||
</td>
|
||
<td class="content">
|
||
You need to have all the necessary Groovy plugins
|
||
installed for your IDE to properly resolve the sources. For example, in
|
||
Intellij IDEA, having both the Eclipse Groovy Compiler Plugin and the GMavenPlus Intellij
|
||
Plugin results in properly imported project.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="admonitionblock important">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<i class="fa icon-important" title="Important"></i>
|
||
</td>
|
||
<td class="content">
|
||
Spring Cloud Contract builds Docker images. Remember to
|
||
have Docker installed.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="admonitionblock important">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<i class="fa icon-important" title="Important"></i>
|
||
</td>
|
||
<td class="content">
|
||
If you want to run the build in offline mode, you must have Maven 3.5.2+ installed.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_project_structure"><a class="link" href="#_project_structure">Project structure</a></h3>
|
||
<div class="paragraph">
|
||
<p>The following listing shows the Spring Cloud Contract folder structure:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>├── config
|
||
├── docker
|
||
├── samples
|
||
├── scripts
|
||
├── specs
|
||
├── spring-cloud-contract-dependencies
|
||
├── spring-cloud-contract-shade
|
||
├── spring-cloud-contract-starters
|
||
├── spring-cloud-contract-stub-runner
|
||
├── spring-cloud-contract-stub-runner-boot
|
||
├── spring-cloud-contract-tools
|
||
├── spring-cloud-contract-verifier
|
||
├── spring-cloud-contract-wiremock
|
||
└── tests</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>The following list describes each of the top-level folders in the project structure:</p>
|
||
</div>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>config</code>: Folder contains setup for Spring Cloud Release Tools automated release process</p>
|
||
</li>
|
||
<li>
|
||
<p><code>docker</code>: Folder contains docker images</p>
|
||
</li>
|
||
<li>
|
||
<p><code>samples</code>: Folder contains test samples together with standalone ones used also to build documentation</p>
|
||
</li>
|
||
<li>
|
||
<p><code>scripts</code>: Contains scripts to build and test <code>Spring Cloud Contract</code> with Maven, Gradle and standalone projects</p>
|
||
</li>
|
||
<li>
|
||
<p><code>specs</code>: Contains specifications for the Contract DSL.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-dependencies</code>: Contains Spring Cloud Contract BOM</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-shade</code>: Shaded dependencies used by the plugins</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-starters</code>: Contains Spring Cloud Contract Starters</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-spec</code>: Contains specification modules (contains concept of a Contract)</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-stub-runner</code>: Contains Stub Runner related modules</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-stub-runner-boot</code>: Contains Stub Runner Boot app</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-tools</code>: Gradle and Maven plugin for <code>Spring Cloud Contract Verifier</code></p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-verifier</code>: Core of the <code>Spring Cloud Contract Verifier</code> functionality</p>
|
||
</li>
|
||
<li>
|
||
<p><code>spring-cloud-contract-wiremock</code>: All WireMock related functionality</p>
|
||
</li>
|
||
<li>
|
||
<p><code>tests</code>: Integration tests for different messaging technologies</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_commands"><a class="link" href="#_commands">Commands</a></h3>
|
||
<div class="paragraph">
|
||
<p>To build the core functionality together with the Maven Plugin, you can run the following
|
||
command:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>./mvnw clean install -P integration</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Calling that function builds the core, the Maven plugin, and the Gradle plugin and runs
|
||
end-to_end tests on the
|
||
standalone samples in the proper order (both for Maven and Gradle).</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>To build only the Gradle Plugin, you can run the following commands:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>cd spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin
|
||
./gradlew clean build</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_helpful_scripts"><a class="link" href="#_helpful_scripts">Helpful scripts</a></h3>
|
||
<div class="paragraph">
|
||
<p>We provide a couple of helpful scripts to build the project.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>To build the project in parallel (by default, it uses four cores, but you can change it),
|
||
run the following command:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>./scripts/parallelBuild.sh</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>To use eight 8 cores, run thke following command:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>CORES=8 ./scripts/parallelBuild.sh</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>To build the project without any integration tests (by default, this uses one core), run
|
||
the following command:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>./scripts/noIntegration.sh</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>To use eight cores, run the following command:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>CORES=8 ./scripts/noIntegration.sh</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>To generate the documentation (for both the root project and the maven plugin), run the
|
||
following command:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code>./scripts/generateDocs.sh</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script>
|
||
<script type="text/javascript" src="js/toc.js"></script>
|
||
<link rel="stylesheet" href="js/highlight/styles/atom-one-dark-reasonable.min.css">
|
||
<script src="js/highlight/highlight.min.js"></script>
|
||
<script>hljs.initHighlighting()</script>
|
||
</body>
|
||
</html> |