1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Commit Graph

177 Commits

Author SHA1 Message Date
Marcus Holl
79475732f9
Upload to transport request scenario (#855)
Co-authored-by: Christoph Szymanski <spamerella@gmx.de>
Co-authored-by: SarahNoack <44202907+SarahNoack@users.noreply.github.com>
2020-02-21 16:16:15 +01:00
Florian Wilhelm
1b6781c1e9
Move docs of Cloud SDK Pipeline (#1167) 2020-02-18 17:51:44 +01:00
Oliver Nocon
d5bc8db50e
Add missing pages to documentation (#1172)
* Create spinnakerTriggerPipeline.md
* Update mkdocs.yml
2020-02-12 08:53:32 +01:00
dominiklendle
2007a94174
Add step cloudFoundryDeleteService (#1097) 2020-02-10 14:53:12 +01:00
RainerHimmeroeder
188686f5a7 add step materializeLogFile to jenkins library (#1046) 2019-12-16 21:09:25 +00:00
Thorsten Duda
7b6a7a051c
Merge branch 'master' into xsa-docu-patch 2019-12-13 09:00:43 +01:00
Stengel
7c1d0a742f Merge remote-tracking branch 'upstream/master' into J365 2019-12-12 11:02:10 +01:00
Thorsten Duda
04177c8b1a
Add XSA scenario in navigation 2019-12-12 08:16:22 +01:00
Stengel
cf53772af6 Change title of guided tour: PR800 once 2019-12-09 15:48:36 +01:00
Thorsten Duda
09bf1fef96
Merge branch 'master' into J365 2019-12-06 08:51:20 +01:00
Stengel
470c8e1eb1 PCDES-365 - Describe Piper usage without cx-server
integrate into guided tour/mkdocs
remove static plugin list
2019-12-02 14:53:34 +01:00
Daniel Mieg
2ad57f3d19 Add step cloudFoundryCreateServiceKey (#989) 2019-12-02 14:02:51 +01:00
Shanuson
77cd7e1025 Add link of step cloudFoundryCreateService to docu sidebar (#991) 2019-11-21 08:27:06 +01:00
Daniel Mieg
2e0bf3ac34 Add step to pull repository to ABAP in SAP Cloud Platform (#907) 2019-11-07 15:40:45 +01:00
Thorsten Duda
6604a82eb1 remove double scenarios entry 2019-10-28 16:47:57 +01:00
Thorsten Duda
800eeffeae remove double navigation entry 2019-10-28 13:56:11 +01:00
Marcus Holl
945599c109
docu xsdeploy scenario (#840) 2019-10-23 11:03:17 +02:00
Marcus Holl
61a91b5f25
Add containerPushToRegistry to docu index (#862) 2019-09-25 11:00:35 +02:00
Marcus Holl
96365d29f7
Add buildExecute to docu index. (#860) 2019-09-25 08:55:51 +02:00
Florian Wilhelm
e041f45183
Streamline documentation to reflect project "piper" (#875) 2019-09-19 14:17:41 +02:00
Sarah Noack
54cbc403c0 Add SAP Cloud Platform Transport Management scenario 2019-09-18 13:46:40 +02:00
Marcus Holl
e54f18e6bc
Introduce xsDeploy step (#749)
Introduce xs deploy
2019-09-11 13:42:38 +02:00
TheFonz2017
41dcebb3a5 Variable Substitution in YAML Files (#852)
* Changes:
- New YamlSubstituteVariables step to substitute variables in YAML files with values from another YAML
- New Tests, that check the different substitution patterns.
- Added test resources, including various manifest and variables files.
- Improved usage of JenkinsLoggingRule
- Improved JenkinsReadYamlRule to properly reflect the mocked library's behaviour.
- Added a new JenkinsWriteYamlRule.

* Changes:
- added a Logger that checks a config.verbose flag before it logs debug messages.
- changed error handling to rethrow Yaml parsing exception in case of wrongly-formatted Yaml files.
- changed JenkinsWriteYamlRule to capture Yaml file details of every invocation of writeYaml. This allows sanity checks at end of tests, even if there were multiple invocations.
- adjusted tests.

* Changes:
- Removed javadoc-code blocks from API documentation since they are not supported.
- Removed skipDeletion boolean.
- Added a new deleteFile script which deletes a file if present.
- Added a new JenkinsDeleteFileRule to mock deleteFile script and optionally skip deletion for tests.
- Adjusted yamlSubstituteVariables script.
- Adjusted tests to include new JenkinsDeleteFileRule.
- Changed code that deletes an already existing output file to produce better logs.

* Changes:
- Turned yamlSubstituteVariables into a script that works purely based on Yaml data (not files).
- Added a new cfManifestSubstituteVariables that uses yamlSubstituteVariables under the hood but works based on files.
- Adjusted tests, and added new ones.

* Adjusted documentation and a few log statements.

* Changed documentation to no longer include javadoc code statements.

* Made mocking of deletion of a file a default. Adjusted tests.

* Changed signature of yamlSubstituteVariables' call method to return void.

* Changes:
- Fixed naming issues in deleteFile.
- Renamed Logger to DebugHelper.
- Fixed some documentation.

* Changed implementation of deleteFile not to use java.io.File - which is evil when using it for file operations.

* PROPERLY Changed implementation of deleteFile not to use java.io.File - which is evil when using it for file operations.

* Changes:
- Added tests for deleteFile script
- Changed JenkinsFileExistsRule to also keep track of which files have been queried for existence.

* Changes:
- Removed java.io.File usage from cfManifestSubstituteVariables and using fileExists instead now.
- Adjusted tests.

* Wrapped file path inside ticks to allow spaces in file path when calling deleteFile.

* Removed null checks of mandatory parameters, and resorted to ConfigurationHelper.withMandatoryProperty

* Fixed a NullPointer due to weird Jenkins / Groovy behaviour.

* Changes:
- Turned yamlSubstituteVariables step into a utils class.
- Added tests
- Adjusted cfManifestSubstituteVariables to use utils class instead of step.
- Adjusted tests
- Adjusted APIs of DebugHelper.

* Re-introduced log statement that shows what variables are being replaced and with what.

* Changing API of YamlUtils to take the script and config as input.

* Test

* Test

* Test

* Test

* Test

* Fixing issue.

* Fixing issue.

* Changes:
- Refactored DebugHelper and YamlUtils to make usage nicer and rely on dependency injection.
- Removed Field for DebugHelper and turned it into local variable.
- Adjusted classes using the above.
- Adjusted tests where necessary.

* Added link to CF standards to YamlUtils also.

* Add docu for step cfManifestSubstituteVariables.md

* Added documentation.

* Added missing script parameter to documentation. Some steps document it, some don't. Right now you need it, so we document it.

* Fixed some layouting and typos

* Beautified exception listing.

* Removed trailing whitespaces to make code climate checks pass.

* Trying to get documentation generated, with all the exceptions to markup one should not use.

* cosmetics.

* cosmetics, part 2

* Code climate changes...

* Inlined deleteFile step.

* Added two more tests to properly check file deletion and output handling.

* Changes:
- adjusted API to take a list of variables files, as does 'cf push --vars-file'
- adjusted API to allow for an optional list of variable key-value-maps as does 'cf push --vars'
- reproduced conflict resolution and overriding behavior of variables files and vars lists
- adjusted tests and documentation

* Added missing paramter to doc comment.

* Re-checked docs for missing paramters or params that have no counterpart in the method signature.

* Adjusted documentation.

* Removed absolute path usage from documentation.

* corrected documentation.

* Changed javadoc comment to plain comment.

* Turned all comments to plain comments.
2019-09-06 10:20:35 +02:00
Marcus Holl
3d94ce4770
Add tmpUpload to mkdocs index page (#801) 2019-07-22 12:08:11 +02:00
Christopher Fenner
5bf7cda940
add new step piperPublishNotifications (#652)
* add new step for notification publication

* add test cases

* add helper method

* correct import

* Update pom.xml

* add step to post section

* add step piperPublishNotifications

* move step to end of pipeline to gather all findings

* use handlePipelineStepErrors step

* use commonPipelineEnvironment

* correct reporting

* add configuration

* fix typos

* fix rule setup

* remove test scope

* add method to fetch full build log

* add methods for warnings-ng parser creation

* remove warnings plugin coding

* add default parser settings

* change parameter handling for parser creation

* adapt step

* fix parser creation

* use ParserConfig.contains

* use correct parameter name

* correct parser regex

* change issue creation

* use classloader

* fix typo

* Revert "fix typo"

This reverts commit 446a201ae4.

* Revert "use classloader"

This reverts commit a896487032.

* rename step to piperPublishWarnings

* extract recordIssuesSettings to defaults

* make addWarningsNGParser non-static

* remove node

* adjust test case

* add docs

* rename log file

* fix tests

* fix typos

* rename parameter

* add import for IOUtils

* check plugin activation

* add comment for class loader usage
2019-07-18 12:09:54 +02:00
Oliver Nocon
225cf2485b
Docker Pipeline - fixes and small adoptions (#779)
* buildExecute: Docker case - minor fixes
* properly care for empty `containerBuildOptions`
* verbose output wrt stashing
* add stage ordinals
* fix wrong script reference
* fix null reference
* adapt stage defaults and allow bats tests
* propagate github org and repo
* add test for bats
2019-07-05 16:32:24 +02:00
Oliver Nocon
9e539e68ee
Piper pipeline - enhance stages (#755)
* fill PRVoting stage with content
* add prVoting stage incl. tests
* add Build stage incl. Tests
* add docs pages
* add additional unit test stage
* add acceptance stage and additional documentation ...
* add release stage content
* add promote stage
* add Security stage, fix defaults for Promote stage
* fix issue in doc generation
2019-07-03 10:13:26 +02:00
andre2007
36c029b344 Add dubExecute step (#754)
* Add dubExecute step
* Fix test
2019-06-19 16:52:18 +02:00
Marcus Holl
dfe5374221 Add kanikoExec to docu index (#714)
was missing in mkdocs.yml
2019-06-19 11:08:09 +02:00
Roland Stengel
2313a83dd6 Merge branch 'master' of github.com:SAP/jenkins-library into revdoc 2019-06-12 11:47:37 +02:00
Christopher Fenner
a6e11e7fd3
add HaDoLint to docs (#744) 2019-06-06 13:52:20 +02:00
Roland Stengel
5aa0a35934 Merge branch 'master' of github.com:SAP/jenkins-library into revdoc2 2019-05-23 09:33:32 +02:00
Roland Stengel
523f603071 review documentation
- clear separation of README.md from
  https://sap.github.io/jenkins-library/
- enhanced https://sap.github.io/jenkins-library/home
- introduction of guided tour
2019-05-23 09:21:41 +02:00
Christopher Fenner
c52d1ceb0d
add Sonar docs link (#704) 2019-05-14 10:59:52 +02:00
Oliver Nocon
729cd0ab30
detectExecuteScan - add doc to docs structure (#699) 2019-05-10 08:06:38 +02:00
Alejandra Ferreiro Vidal
e3dd6fd665 add new step docu to index 2019-04-17 16:28:45 +02:00
Christopher Fenner
39bc7b043c
Travis: use GHPages deploy provider (#645)
* remove GHDeploy script

* build MKDocs from docs folder

* use GHDeploy provider
2019-04-10 12:26:54 +02:00
Sven Merk
aaf969e0cf
Merge branch 'master' into whitesource-step 2019-03-29 11:01:15 +01:00
Alejandra Ferreiro Vidal
eba4c68a49 remove documentation 2019-03-29 08:44:36 +01:00
Sven Merk
991dd5ec51
Merge branch 'master' into whitesource-step 2019-03-22 11:58:01 +01:00
Christopher Fenner
7069f29ec5
snykExecute: add missing documentation (#570)
* add docs for snykExecute

* add link to new docs page
2019-03-18 11:08:41 +01:00
Sven Merk
6b61bc1b98 Updated documentation 2019-03-08 12:33:31 +01:00
yemengsap
38c5a0d779 Add npmExecute step (#491) 2019-02-21 19:14:48 +01:00
Oliver Nocon
793df723cf add step slackSendNotification (#338)
* add step slackSendNotification

This step allows to send Slack notifications in case of pipeline failures.

* add SWA reporting

* remove allowBuildFailure

* add GENERAL_CONFIG_KEYS

* update STEP_NAME

* add missing import

* fix MD findings

* adjust rule name to be aligned with #455
2019-02-13 16:45:35 +01:00
SarahNoack
f42b2502da Add CAP Scenario in Navigation (#502) 2019-02-08 15:45:24 +01:00
Marcus Holl
df90255739 publish docu for step uiVeri5ExecuteTests (#499) 2019-02-08 11:15:32 +01:00
Christoph Szymanski
139ed7b15d Align Navigation Text with Header 2019-02-05 18:46:27 +01:00
Oliver Nocon
3b2e42c74f
Add step containerExecuteStructureTest (#441)
* add step containerExecuteStructureTest
* include PR-review feedback
* documentation
2019-01-31 09:39:13 +01:00
SarahNoack
c7564a6a99 Doc: Changed Heading for UI5 Scenario (#438) 2019-01-18 09:29:50 +01:00
Marcus Holl
ab83e9f7b8 Generate docu during travis build (for checkChangeInDevelopment) 2019-01-18 08:57:54 +01:00
SarahNoack
4803695185 Documentation: Hybrid Applications with Jenkins and SAP Solution Manager (#410) 2019-01-15 17:45:26 +01:00
Marcus Holl
db5022a4ff New Scenario Step: SAP UI5 on SAP Cloud Platform (#388)
This scenario builds a UI5 app and deploys it to SAP Cloud Platform (neo).
2019-01-15 13:32:01 +01:00
Christopher Fenner
caf54b0e68 docs: add reference to newman page (#430) 2019-01-11 08:02:30 +01:00
Christopher Fenner
9a1ab37c0b
add new step karmaExecuteTests (#351)
* add new step for karma execution

* add defaults

* Update karmaExecuteTests.groovy

* add key comments

* add test case

* docs

* add step docs

* add step docs

* Update karmaExecuteTests.md

* complete docs

* Update karmaExecuteTests.md

* init `script` the "new way"

* Update karmaExecuteTests.groovy

* Update karmaExecuteTests.groovy
2018-11-08 12:15:15 +01:00
Oliver Nocon
a8a29b753a
add step githubPublishRelease (#345)
This step allows to easily create a new release for your GitHub repository

* include PR review feedback - add additional labels
* consider return status of api call
2018-10-25 16:56:09 +02:00
Oliver Nocon
455461d3c1
add step pipelineRestartSteps (#337)
This step allows to restart a set of steps in order to retry in case of e.g. infrastructure failures which first need to be fixed.

* update documentation
2018-10-18 08:51:48 +02:00
Oliver Nocon
0e5ccabdae
add step gaugeExecuteTests (#340)
* seleniumExecuteTests - fixes
* add step gaugeExecuteTests incl. tests
* add documentation
* add more config options
2018-10-17 16:44:20 +02:00
Oliver Nocon
1f8b94528c
add step mailSendNotification (#336)
This step allows to send email notifications in case of pipeline failures.
2018-10-17 12:05:11 +02:00
Oliver Nocon
17e8390511
add step healthExecuteCheck (#339)
This step allows to perform a basic health check on an installed application.
It verifies that your app has a simple health endpoint available and that there is no error when calling it.
2018-10-12 16:06:41 +02:00
Oliver Nocon
7a961ef38e
seleniumExecuteTests - add step to run Selenium tests (#318)
It comes with an extension to executeDocker and executeDockerOnKubernetes to run sidecar containers.

This helps to execute Selenium tests using two Docker images:

1. Execution runtime for tests (e.g. node image)
2. Selenium instance which holds Selenium server + browser

* add documentation & some name cleanup
* include PR feedback
* add step documentation to structure
2018-10-04 17:06:42 +02:00
Thorsten Duda
72f611c5c2 fix mkdocs issue
- introduced docker mkdocs build
- changed pages to nav in mkdocs.yml due to newer mkdocs version
2018-09-25 14:03:22 +02:00
Ramachandra Kamath Arbettu
c84114c3df
Enable support for executing on K8S as a step (#231)
* Create executeDockerOnKubernetes.groovy

* Update dockerExecute.groovy

* Create SysEnvTest.groovy

* Update default_pipeline_environment.yml

* Update executeDockerOnKubernetes.groovy

* Create utils object

* update docker image

* Update mavenExecute.groovy

* Use pipeline-lib than piper

* Check container name

* Always change ownership to 1000

* Check for map

* Fix command

* Move chmod to docker execute

* Use generic name for the pod

* runAsPod has been added

* Return false if script has no k8smapping

* fix syntax error

* Null checks

* Returnn dockerImage name

* Check method body

* Return container name

* Cleanup echos

* Use runAsPod

* Rename step

* Use official jenkins JNLP agent image

* Construct containersMap

* Check if kubernetes plugin is active

* Support JaaS

* pass script object

* Move configuration to default section

* Use generic flag to check if running in k8s

* fix jnlp agent name

* Solve travis errors

* Improvements to config and changes to name of the method

* Improvements to config

* Fix type

* Rename stash config

* add import

* Fix map order

* Fix jnlp agent name

* cleanup config usage

* Check if config is enabled

* Use nested k8s mapping

* Support custom docker workspace and move flag to env

* Feature/k8s stage (#1)

* Use nested k8s mapping

* Support custom docker workspace and move flag to env

* Check dockerOptions value

* Support local execution

* Add tests for dockerExecute

* Move config to step and Fix tests

* Use step configuration while running as a pod

* Streamline parameter and config initialization

* Streamline parameter and tests

* Cleanup and align variable name

* Use default JNLP agent if one not defined in config

* Add tests for runInsidePod. Ensure lowercase container names.

* Improve tests and remove unused code block

* Fix permission issues

* Perform stashing and unstashing inside container

* Use custom jnlp agent due to user id restriction

* Fix tests after jnlp agent change

* Address review comments

* Initialize script to default value if null

* Address review comments

* Update exeception handling and documentation

* Improve documentation

* correct indent

* Link documents to the index page

* Merge containerExecute and dockerExecuteOnKuberenetes step and address comments.

* Update dockerExecute.md

* Update dockerExecuteOnKubernetes.md

* Update default_pipeline_environment.yml

* update documentation

* Update documentation. Use annotation for singleton

* Update DockerExecuteOnKubernetesTest.groovy

* Update dockerExecute.groovy

* Update dockerExecuteOnKubernetes.groovy

* Improve documentation and test case names

* neoDeploy: switch to chained ConfigurationHelper (#244)

* switch neoDeploy to chained ConfigurationHelper

* update imports

* Improve tests

* Address review comments

* Improve documentation

* made dockerImage non-mandatory parm, improved test

* add comment regarding userid assumption
2018-08-21 15:45:59 +02:00
Oliver Nocon
17ee927807
batsExecuteTests - add step for executing bats-core (#254)
details are available in the documentation contained in this PR
2018-08-15 11:41:01 +02:00
Oliver Nocon
08a284aac4 update docs 2018-08-15 09:30:35 +02:00
Oliver Nocon
cd4a9f226e
Add collection of library telemetry data (#239)
* add telemetry collection
* add telemetry reporting for first steps
* fix documentation formatting
2018-08-06 08:57:36 +02:00
Marcus Holl
fd945b40e7 Provide docu for checkChangeInDevelopment 2018-06-28 15:37:13 +02:00
Marcus Holl
23e5c9de6e Add new transport related steps to documentation index 2018-06-26 16:32:01 +02:00
Oliver Nocon
96cc75d72a pipelineStashFiles - cleanup & documentation
This contains some cleanups to the code
plus documentation for the step
2018-06-01 12:33:06 +02:00
Marcus Holl
056f128568 Introduce piper API 2018-03-09 15:19:08 +01:00
Oliver Nocon
fbd03a88da
Step for automatic versioning (#65)
It contains:

* versioning step artifactSetVersion
* versioning implementation for Maven & Docker
* enhancements to commonPipelineEnvironment
* extended default configuration
* new utils object for git-related tasks
* automated tests incl. new Rules and resources
* incorporated PR feedback
* step documentation
2018-02-07 13:17:33 +01:00
Oliver Nocon
749aa5e7ed
InfluxDB support (#52)
* adding step for writing metrics to InfluxDB including dependencies
* added documentation
* incorporated PR feedback
2018-01-24 09:55:38 +01:00
Daniel Kurzynski
22ee06dc17 Enable configuration via yaml file + mavenExecute as example (#18)
* Enable configuration via yaml file
* Add documentation 
* Add tests
2017-12-06 12:03:06 +01:00
Marcus Holl
88ac3ae43e Rename externalPipelineExecute to pipelineExecute 2017-12-04 10:51:42 +01:00
Marcus Holl
bbe799fd19 Rename centralPipelineLoad step to externalPipelineExecute 2017-12-04 10:51:42 +01:00
Oliver Feldmann
b4d17fa929 Documentation for 'centralPipelineLoad' 2017-12-04 10:51:42 +01:00
Ken Arnold
a23f3e82fe Update mkdocs.yml to MkDocs 0.17.0 format
MkDocs 0.17 features theme customization options [1] which are picked up
supported with mkdocs-material 2.0.1 [2] and later. These are now the
minimum required versions to compile our gh-pages documentation.

[1] http://www.mkdocs.org/about/release-notes/#major-additions-to-version-0170
[2] https://github.com/squidfunk/mkdocs-material/releases/tag/2.0.0
2017-11-17 17:37:09 +01:00
Oliver Nocon
47c195805f Initial version of piper-lib. 2017-11-10 16:30:52 +01:00