Skip to content

Commit 286a1f0

Browse files
fwilhefwilhe
authored
Merge pull request #145 from SAP/return-types
Explicitly state return types fixes #144
2 parents 788e64c + dfa7b14 commit 286a1f0

8 files changed

+24
-27
lines changed

‎src/com/sap/piper/ConfigurationLoader.groovy

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,37 @@ import com.cloudbees.groovy.cps.NonCPS
44

55
class ConfigurationLoader implements Serializable {
66
@NonCPS
7-
def static stepConfiguration(script, String stepName) {
7+
static Map stepConfiguration(script, String stepName) {
88
return loadConfiguration(script, 'steps', stepName, ConfigurationType.CUSTOM_CONFIGURATION)
99
}
1010

1111
@NonCPS
12-
def static stageConfiguration(script, String stageName) {
12+
static Map stageConfiguration(script, String stageName) {
1313
return loadConfiguration(script, 'stages', stageName, ConfigurationType.CUSTOM_CONFIGURATION)
1414
}
1515

1616
@NonCPS
17-
def static defaultStepConfiguration(script, String stepName) {
17+
static Map defaultStepConfiguration(script, String stepName) {
1818
return loadConfiguration(script, 'steps', stepName, ConfigurationType.DEFAULT_CONFIGURATION)
1919
}
2020

2121
@NonCPS
22-
def static defaultStageConfiguration(script, String stageName) {
22+
static Map defaultStageConfiguration(script, String stageName) {
2323
return loadConfiguration(script, 'stages', stageName, ConfigurationType.DEFAULT_CONFIGURATION)
2424
}
2525

2626
@NonCPS
27-
def static generalConfiguration(script){
27+
static Map generalConfiguration(script){
2828
return script?.commonPipelineEnvironment?.configuration?.general ?: [:]
2929
}
3030

3131
@NonCPS
32-
def static defaultGeneralConfiguration(script){
32+
static Map defaultGeneralConfiguration(script){
3333
return DefaultValueCache.getInstance()?.getDefaultValues()?.general ?: [:]
3434
}
3535

3636
@NonCPS
37-
private static loadConfiguration(script, String type, String entryName, ConfigurationType configType){
37+
private static Map loadConfiguration(script, String type, String entryName, ConfigurationType configType){
3838
switch (configType) {
3939
case ConfigurationType.CUSTOM_CONFIGURATION:
4040
return script?.commonPipelineEnvironment?.configuration?.get(type)?.get(entryName) ?: [:]

‎src/com/sap/piper/ConfigurationMerger.groovy

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
package com.sap.piper
22

33
import com.cloudbees.groovy.cps.NonCPS
4-
54
import com.sap.piper.MapUtils
65

76
class ConfigurationMerger {
87
@NonCPS
9-
def static merge(Map configs, Set configKeys, Map defaults) {
8+
static Map merge(Map configs, Set configKeys, Map defaults) {
109
Map filteredConfig = configKeys?configs.subMap(configKeys):configs
1110
Map merged = [:]
1211

@@ -24,7 +23,7 @@ class ConfigurationMerger {
2423
}
2524

2625
@NonCPS
27-
def static merge(
26+
static Map merge(
2827
Map parameters, Set parameterKeys,
2928
Map configuration, Set configurationKeys,
3029
Map defaults=[:]
@@ -36,7 +35,7 @@ class ConfigurationMerger {
3635
}
3736

3837
@NonCPS
39-
def static merge(
38+
static Map merge(
4039
def script, def stepName,
4140
Map parameters, Set parameterKeys,
4241
Set stepConfigurationKeys
@@ -45,7 +44,7 @@ class ConfigurationMerger {
4544
}
4645

4746
@NonCPS
48-
def static merge(
47+
static Map merge(
4948
def script, def stepName,
5049
Map parameters, Set parameterKeys,
5150
Map pipelineData,
@@ -58,7 +57,7 @@ class ConfigurationMerger {
5857
}
5958

6059
@NonCPS
61-
def static mergeWithPipelineData(Map parameters, Set parameterKeys,
60+
static Map mergeWithPipelineData(Map parameters, Set parameterKeys,
6261
Map pipelineDataMap,
6362
Map configurationMap, Set configurationKeys,
6463
Map stepDefaults=[:]

‎src/com/sap/piper/EnvironmentUtils.groovy

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import hudson.AbortException
55

66
class EnvironmentUtils implements Serializable {
77

8-
def static isEnvironmentVariable(script, variable) {
8+
static boolean isEnvironmentVariable(script, variable) {
99
return !getEnvironmentVariable(script, variable).isEmpty()
1010
}
1111

12-
def static getEnvironmentVariable(script, variable) {
12+
static String getEnvironmentVariable(script, variable) {
1313
try {
1414
def envVar = script.sh returnStdout: true, script: """#!/bin/bash --login
1515
echo \$$variable"""

‎src/com/sap/piper/FileUtils.groovy

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
package com.sap.piper
22

33
import hudson.AbortException
4-
import java.io.File
5-
64

75
class FileUtils implements Serializable {
86

9-
static directoryOrFileExists(script, dirOrFile) {
7+
static boolean directoryOrFileExists(script, dirOrFile) {
108
if (!dirOrFile) throw new IllegalArgumentException("The parameter 'dirOrFile' can not be null or empty.")
119
def returnStatus = script.sh returnStatus: true, script: """
1210
set +x
@@ -24,7 +22,7 @@ class FileUtils implements Serializable {
2422
return returnStatus == 0
2523
}
2624

27-
static isDirectory(script, dir) {
25+
static boolean isDirectory(script, dir) {
2826
if (!dir) throw new IllegalArgumentException("The parameter 'dir' can not be null or empty.")
2927
def returnStatus = script.sh returnStatus: true, script: """
3028
set +x
@@ -39,7 +37,7 @@ class FileUtils implements Serializable {
3937
return returnStatus == 0
4038
}
4139

42-
static isDirectoryEmpty(script, dir) {
40+
static boolean isDirectoryEmpty(script, dir) {
4341
if (!dir) throw new IllegalArgumentException("The parameter 'dir' can not be null or empty.")
4442
def returnStatus = script.sh returnStatus: true, script: """
4543
set +x
@@ -54,7 +52,7 @@ class FileUtils implements Serializable {
5452
return returnStatus == 1
5553
}
5654

57-
static isFile(script, filePath) {
55+
static boolean isFile(script, filePath) {
5856
if (!filePath) throw new IllegalArgumentException("The parameter 'filePath' can not be null or empty.")
5957
def returnStatus = script.sh returnStatus: true, script: """
6058
set +x

‎src/com/sap/piper/GitUtils.groovy

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
package com.sap.piper
22

3-
def getGitCommitIdOrNull() {
3+
String getGitCommitIdOrNull() {
44
if (fileExists('.git')) {
55
return sh(returnStdout: true, script: 'git rev-parse HEAD').trim()
66
} else {
77
return null
88
}
99
}
1010

11-
def getGitCommitId() {
11+
String getGitCommitId() {
1212
return sh(returnStdout: true, script: 'git rev-parse HEAD').trim()
1313
}

‎src/com/sap/piper/JsonUtils.groovy

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ package com.sap.piper
33
import com.cloudbees.groovy.cps.NonCPS
44

55
@NonCPS
6-
def getPrettyJsonString(object) {
6+
String getPrettyJsonString(object) {
77
return groovy.json.JsonOutput.prettyPrint(groovy.json.JsonOutput.toJson(object))
88
}

‎src/com/sap/piper/MapUtils.groovy

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import com.cloudbees.groovy.cps.NonCPS
44

55
class MapUtils implements Serializable {
66
@NonCPS
7-
static isMap(object){
7+
static boolean isMap(object){
88
return object in Map
99
}
1010
}

‎src/com/sap/piper/Version.groovy

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ class Version implements Serializable {
3434
return major == version.major && minor == version.minor && patch == version.patch
3535
}
3636

37-
def isHigher(version) {
37+
boolean isHigher(version) {
3838
if (!version) throw new IllegalArgumentException("The parameter 'version' can not be null.")
3939
return major > version.major || major == version.major && ( minor > version.minor || minor == version.minor && patch > version.patch)
4040
}
4141

42-
def isCompatibleVersion(version) {
42+
boolean isCompatibleVersion(version) {
4343
if (!version) throw new IllegalArgumentException("The parameter 'version' can not be null.")
4444
return this == version || isHigher(version) && major == version.major
4545
}

0 commit comments

Comments
 (0)