From 950135f67659ee40bbec6549ca3c5557f24e37ba Mon Sep 17 00:00:00 2001 From: buildmaster Date: Mon, 16 Jan 2017 13:01:11 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- .../checkstyle.html | 326 +++++++++++++++ .../checkstyle.rss | 208 ++++++++++ .../complex-content.html | 73 +++- .../complex.html | 81 +++- .../configs.html | 379 ++++++++++++++++++ .../convert-mojo.html | 205 ++++++++-- .../generateStubs-mojo.html | 93 ++++- .../generateTests-mojo.html | 278 +++++++++++-- .../help-mojo.html | 40 +- spring-cloud-contract-maven-plugin/index.html | 167 +++++++- .../integration.html | 70 ++-- .../issue-tracking.html | 70 ++-- spring-cloud-contract-maven-plugin/junit.html | 68 +++- .../license.html | 165 ++++---- .../plugin-info.html | 57 ++- .../plugin-management.html | 78 ++-- .../plugins.html | 136 +++---- .../project-info.html | 78 +--- .../project-reports.html | 48 ++- .../project-summary.html | 70 ++-- .../run-mojo.html | 44 +- .../sitemap.html | 107 ++++- .../source-repository.html | 66 +-- spring-cloud-contract-maven-plugin/spock.html | 68 +++- .../team-list.html | 75 ++-- spring-cloud-contract-maven-plugin/usage.html | 68 +++- spring-cloud-contract.html | 6 +- 27 files changed, 2444 insertions(+), 680 deletions(-) create mode 100644 spring-cloud-contract-maven-plugin/checkstyle.html create mode 100644 spring-cloud-contract-maven-plugin/checkstyle.rss create mode 100644 spring-cloud-contract-maven-plugin/configs.html diff --git a/spring-cloud-contract-maven-plugin/checkstyle.html b/spring-cloud-contract-maven-plugin/checkstyle.html new file mode 100644 index 0000000000..4249502559 --- /dev/null +++ b/spring-cloud-contract-maven-plugin/checkstyle.html @@ -0,0 +1,326 @@ + + + + + + + + + Spring Cloud Contract Maven Plugin – Checkstyle Results + + + + + + + + + + + + + + + + + Fork me on GitHub + + + + + + +
+
+
+ + + + + + + + + + + +
+ +
+
+ + +
+ + + + + +
+
+
+ + + + +
+ +
+
+
+
+
+ + Built by Maven + +
+
+
+ + +
+ +
+

Checkstyle Results

+

The following document contains the results of Checkstyle 6.11.2 with checkstyle.xml ruleset. rss feed

+
+

Summary

+ + + + + + + + + + +
Files Info Warnings Errors
11000
+
+

Files

+ + + + + +
File I W E
+
+

Rules

+ + + + + +
CategoryRuleViolationsSeverity
+
+

Details

+
+
+
+ +
+ + + + diff --git a/spring-cloud-contract-maven-plugin/checkstyle.rss b/spring-cloud-contract-maven-plugin/checkstyle.rss new file mode 100644 index 0000000000..8287aec20a --- /dev/null +++ b/spring-cloud-contract-maven-plugin/checkstyle.rss @@ -0,0 +1,208 @@ + + + + + Spring Cloud Contract Maven Plugin - Checkstyle report + https://github.com/spring-cloud/spring-cloud-contract + Spring Cloud Contract Maven Plugin - Checkstyle report + en-us + ©2016 - 2017 Spring + + File: 11, + Errors: 0, + Warnings: 0, + Infos: 0 + + https://github.com/spring-cloud/spring-cloud-contract/checkstyle.html + +

Click here for the full Checkstyle report.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FilesIWE
+ org/springframework/cloud/contract/maven/verifier/GenerateTestsMojo.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/MavenContractsDownloader.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/GenerateStubsMojo.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/BaseClassMapping.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/stubrunner/AetherStubDownloaderFactory.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/RunMojo.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/CopyContracts.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/stubrunner/RemoteStubRunner.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/stubrunner/LocalStubRunner.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/ManifestCreator.java + + 0 + + 0 + + 0 +
+ org/springframework/cloud/contract/maven/verifier/ConvertMojo.java + + 0 + + 0 + + 0 +
+ + + + + + diff --git a/spring-cloud-contract-maven-plugin/complex-content.html b/spring-cloud-contract-maven-plugin/complex-content.html index ffd89ed576..9c622b1bde 100644 --- a/spring-cloud-contract-maven-plugin/complex-content.html +++ b/spring-cloud-contract-maven-plugin/complex-content.html @@ -9,7 +9,7 @@ - Spring Cloud Contract Verifier Maven Plugin – + Spring Cloud Contract Maven Plugin – @@ -66,6 +66,9 @@
  • Complex Configuration
    • + +
  • Configuration snippets +
  • @@ -75,6 +78,45 @@
  • Spring Cloud Contract
    • + +
  • + Project Documentation +
    • @@ -163,6 +205,13 @@ Complex Configuration + + +
  • + + + + Configuration snippets
  • Related Projects
    • @@ -172,6 +221,21 @@ Spring Cloud Contract +
  • Project Documentation
    • + +
  • + + + + Project Information +
    • + +
  • + + + + Project Reports +
    • @@ -236,6 +300,13 @@

    https://github.com/Codearte/accurest-maven-plugin/tree/master/spring-cloud-contract-tools/spring-cloud-contract-maven-plugin/src/test/projects/complex-configuration

    +
    +

    More samples

    +
    +

    You can check out the Spring Cloud Contract Samples project for +more examples of Maven plugin setup.

    +
    +
    diff --git a/spring-cloud-contract-maven-plugin/complex.html b/spring-cloud-contract-maven-plugin/complex.html index 53636d1e37..c1f972bcd7 100644 --- a/spring-cloud-contract-maven-plugin/complex.html +++ b/spring-cloud-contract-maven-plugin/complex.html @@ -9,7 +9,7 @@ - Spring Cloud Contract Verifier Maven Plugin – + Spring Cloud Contract Maven Plugin – @@ -66,6 +66,9 @@
  • Complex Configuration
    • + +
  • Configuration snippets +
  • @@ -75,6 +78,45 @@
  • Spring Cloud Contract
    • + +
  • + Project Documentation +
    • @@ -162,6 +204,13 @@ Complex Configuration + +
  • + + + + Configuration snippets +
  • Related Projects
  • @@ -170,6 +219,21 @@ Spring Cloud Contract
    • +
  • Project Documentation
    • + +
  • + + + + Project Information +
    • + +
  • + + + + Project Reports +
    • @@ -212,7 +276,7 @@ <goal>generateTests</goal> </goals> <configuration> - <contractsDirectory>src/test/accurest</contractsDirectory> + <contractsDirectory>src/test/contracts</contractsDirectory> <basePackageForTests>com.blogspot.toomuchcoding.frauddetection</basePackageForTests> <testMode>MOCKMVC</testMode> <testFramework>JUNIT</testFramework> @@ -247,7 +311,7 @@ 
    /**
  *
- *  Copyright 2013-2016 the original author or authors.
+ *  Copyright 2013-2017 the original author or authors.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -284,7 +348,7 @@
 
    
 
    /**
  *
- *  Copyright 2013-2016 the original author or authors.
+ *  Copyright 2013-2017 the original author or authors.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -318,7 +382,7 @@
 
    
 
    /**
  *
- *  Copyright 2013-2016 the original author or authors.
+ *  Copyright 2013-2017 the original author or authors.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -369,6 +433,13 @@ org.springframework.cloud.contract.spec.Contract.make {
 
    https://github.com/Codearte/accurest-maven-plugin/tree/master/spring-cloud-contract-tools/spring-cloud-contract-maven-plugin/src/test/projects/complex-configuration
    
 
    
 
    
+
    
+
    More samples
    
+
    
+
    You can check out the Spring Cloud Contract Samples project for
+more examples of Maven plugin setup.
    
+
    
+
    diff --git a/spring-cloud-contract-maven-plugin/configs.html b/spring-cloud-contract-maven-plugin/configs.html new file mode 100644 index 0000000000..444dcc5742 --- /dev/null +++ b/spring-cloud-contract-maven-plugin/configs.html @@ -0,0 +1,379 @@ + + + + + + + + + Spring Cloud Contract Maven Plugin – + + + + + + + + + + + + + + + + + Fork me on GitHub + + + + + + +
    +
    +
    + + + + + + + + + + + +
    + +
    +
    + + +
    + + + + + +
    +
    +
    + + + + +
    + +
    +
    +
    +
    +
    + + Built by Maven + +
    +
    +
    + + +
    + +
    +

    Configuration snippets

    +
    +
    +

    Here you’ll be able to see different Spring Cloud Contract Maven plugin configuration

    +
    +
    +

    Base class from mappings

    +
    +

    Define regular expression mappings to map a contract to its base class.

    +
    +
    +
    +
                            <plugin>
+                                <groupId>org.springframework.cloud</groupId>
+                                <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+                                <configuration>
+                                        <baseClassForTests>com.example.FooBase</baseClassForTests>
+                                        <baseClassMappings>
+                                                <baseClassMapping>
+                                                        <contractPackageRegex>.*com.*</contractPackageRegex>
+                                                        <baseClassFQN>com.example.TestBase</baseClassFQN>
+                                                </baseClassMapping>
+                                        </baseClassMappings>
+                                </configuration>
+                        </plugin>
    +
    +
    +
    +
    +

    Convention based mappings

    +
    +

    Define a package in which base classes are placed. In this case we define +a package called hello. If there’s a contract under /contracts/hello/V1/Contract.groovy` then +we’ll search for a HelloV1Base base class. We’re taking two last folders +from the path and combine them into a class name.

    +
    +
    +
    +
                            <plugin>
+                                <groupId>org.springframework.cloud</groupId>
+                                <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+                                <configuration>
+                                        <packageWithBaseClasses>hello</packageWithBaseClasses>
+                                </configuration>
+                        </plugin>
    +
    +
    +
    +
    +

    Remote contracts

    +
    +

    Here you can see a setup where we point to a repository where the JAR with the +contracts got deployed.

    +
    +
    +
    +
                            <plugin>
+                                <groupId>org.springframework.cloud</groupId>
+                                <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+                                <configuration>
+                                        <contractsRepositoryUrl>http://link/to/your/nexus/or/artifactory/or/sth</contractsRepositoryUrl>
+                                        <contractDependency>
+                                                <groupId>com.example.standalone</groupId>
+                                                <artifactId>contracts</artifactId>
+                                        </contractDependency>
+                                </configuration>
+                        </plugin>
    +
    +
    +
    +
    +

    Setting up repo with common contracts

    +
    +

    A setup of a repo that contains all common contracts. It can exclude the target / build +folder that gets created when you’re installing stubs locally as a consumer.

    +
    +
    +
    +
            <properties>
+                <!-- We don't want the tests to be executed cause we're just build stubs -->
+                <skipTests>true</skipTests>
+                <!-- The target / build folder needs to be excluded - we don't want to check its contents -->
+                <excludeBuildFolders>true</excludeBuildFolders>
+        </properties>
+
+        <build>
+                <plugins>
+                        <plugin>
+                                <groupId>org.springframework.cloud</groupId>
+                                <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+                                <configuration>
+                                        <!-- By default it would search under src/test/resources/ -->
+                                        <contractsDirectory>${project.basedir}</contractsDirectory>
+                                </configuration>
+                        </plugin>
+                </plugins>
+        </build>
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + +
    +
    +
    +

    Copyright © 2016–2017 + Spring. + All rights reserved. +

    +
    + + +
    +
    + + diff --git a/spring-cloud-contract-maven-plugin/convert-mojo.html b/spring-cloud-contract-maven-plugin/convert-mojo.html index ff23198c49..bc628bebd1 100644 --- a/spring-cloud-contract-maven-plugin/convert-mojo.html +++ b/spring-cloud-contract-maven-plugin/convert-mojo.html @@ -1,15 +1,15 @@ - + - Spring Cloud Contract Verifier Maven Plugin – spring-cloud-contract:convert + Spring Cloud Contract Maven Plugin – spring-cloud-contract:convert @@ -66,6 +66,9 @@
  • Complex Configuration
    • + +
  • Configuration snippets +
  • @@ -84,14 +87,6 @@ Project Information
    +

    contractsPath:

    + +
    The path in the JAR with all the contracts where contracts for this +particular service lay. If not provided will be resolved to +groupid/artifactid. Example:
    +
    + If groupid is com.example and +artifactid is service then the resolved +path will be /com/example/artifactid
    + +
      + +
    • Type: java.lang.String
      • + +
    • Required: No
      • + +
    • User Property: contractsPath
      • +
    +

    contractsRepositoryUrl:

    + +
    The URL from which a JAR containing the contracts should get +downloaded. If not provided but artifactid / coordinates notation +was provided then the current Maven's build repositories will be +taken into consideration
    + +
      + +
    • Type: java.lang.String
      • + +
    • Required: No
      • + +
    • User Property: contractsRepositoryUrl
      • +
    +

    contractsWorkOffline:

    + +
    If true then JAR with contracts will be taken from +local maven repository
    + +
      + +
    • Type: boolean
      • + +
    • Required: No
      • + +
    • User Property: contractsWorkOffline
      • + +
    • Default: false
      • +

    destination:

    (no description)
    @@ -385,19 +516,21 @@ written using the GroovyDSL
  • Default: ${basedir}
    • -

    outputDirectory:

    +

    excludeBuildFolders:

    -
    Directory where the generated WireMock stubs from Groovy DSL should -be placed. You can then mention them in your packaging task to -create jar with stubs
    +
    If true then any file laying in a path that contains +build or target will get excluded in +further processing.
      -
    • Type: java.io.File
      • +
    • Type: boolean
    • Required: No
      • -
    • Default: ${project.build.directory}/stubs
      • +
    • User Property: excludeBuildFolders
      • + +
    • Default: false

    skip:

    @@ -429,6 +562,20 @@ maven project.

  • User Property: contractsDirectory
  • Default: ${basedir}
    • +
    +

    stubsDirectory:

    + +
    Directory where the generated WireMock stubs from Groovy DSL should +be placed. You can then mention them in your packaging task to +create jar with stubs
    + +
      + +
    • Type: java.io.File
      • + +
    • Required: No
      • + +
    • Default: ${project.build.directory}/stubs/
    @@ -443,8 +590,8 @@ maven project.