Skip to content

Commit 2bb98c2

Browse files
authored
fix: warn if deprecated configs are used (#8366)
1 parent 75184bf commit 2bb98c2

3 files changed

Lines changed: 148 additions & 73 deletions

File tree

ant/src/main/java/org/owasp/dependencycheck/taskdefs/Check.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1002,6 +1002,8 @@ public void setNodeAuditSkipDevDependencies(Boolean nodeAuditSkipDevDependencies
10021002
*/
10031003
@Deprecated
10041004
public void setRetirejsFilterNonVulnerable(Boolean retireJsFilterNonVulnerable) {
1005+
log("'retirejsFilterNonVulnerable' is deprecated and may be removed in the next major release, please migrate to 'retireJsFilterNonVulnerable'",
1006+
Project.MSG_WARN);
10051007
this.retireJsFilterNonVulnerable = retireJsFilterNonVulnerable;
10061008
}
10071009

@@ -1026,6 +1028,8 @@ public void setRetireJsFilterNonVulnerable(Boolean retireJsFilterNonVulnerable)
10261028
*/
10271029
@Deprecated
10281030
public void addConfiguredRetirejsFilter(final RetirejsFilter retireJsFilter) {
1031+
log("'retirejsFilter' is deprecated and may be removed in the next major release, please migrate to 'retireJsFilter'",
1032+
Project.MSG_WARN);
10291033
retireJsFilters.add(retireJsFilter.getRegex());
10301034
}
10311035

@@ -1229,6 +1233,8 @@ public void setPathToDotnetCore(String pathToCore) {
12291233
*/
12301234
@Deprecated
12311235
public void setOssindexAnalyzerEnabled(Boolean ossindexAnalyzerEnabled) {
1236+
log("'ossindexAnalyzerEnabled' is deprecated and may be removed in the next major release, please migrate to 'ossIndexAnalyzerEnabled'",
1237+
Project.MSG_WARN);
12321238
this.ossindexAnalyzerEnabled = ossindexAnalyzerEnabled;
12331239
}
12341240

@@ -1249,6 +1255,8 @@ public void setOssIndexAnalyzerEnabled(Boolean ossIndexAnalyzerEnabled) {
12491255
*/
12501256
@Deprecated
12511257
public void setOssindexAnalyzerUseCache(Boolean ossindexAnalyzerUseCache) {
1258+
log("'ossindexAnalyzerUseCache' is deprecated and may be removed in the next major release, please migrate to 'ossIndexAnalyzerUseCache'",
1259+
Project.MSG_WARN);
12521260
this.ossindexAnalyzerUseCache = ossindexAnalyzerUseCache;
12531261
}
12541262

@@ -1269,6 +1277,8 @@ public void setOssIndexAnalyzerUseCache(Boolean ossIndexAnalyzerUseCache) {
12691277
*/
12701278
@Deprecated
12711279
public void setOssindexAnalyzerUrl(String ossindexAnalyzerUrl) {
1280+
log("'ossindexAnalyzerUrl' is deprecated and may be removed in the next major release, please migrate to 'ossIndexAnalyzerUrl'",
1281+
Project.MSG_WARN);
12721282
this.ossindexAnalyzerUrl = ossindexAnalyzerUrl;
12731283
}
12741284

@@ -1289,6 +1299,8 @@ public void setOssIndexAnalyzerUrl(String ossIndexAnalyzerUrl) {
12891299
*/
12901300
@Deprecated
12911301
public void setOssindexAnalyzerUsername(String ossindexAnalyzerUsername) {
1302+
log("'ossindexAnalyzerUsername' is deprecated and may be removed in the next major release, please migrate to 'ossIndexAnalyzerUsername'",
1303+
Project.MSG_WARN);
12921304
this.ossindexAnalyzerUsername = ossindexAnalyzerUsername;
12931305
}
12941306

@@ -1309,6 +1321,8 @@ public void setOssIndexAnalyzerUsername(String ossIndexAnalyzerUsername) {
13091321
*/
13101322
@Deprecated
13111323
public void setOssindexAnalyzerPassword(String ossindexAnalyzerPassword) {
1324+
log("'ossindexAnalyzerPassword' is deprecated and may be removed in the next major release, please migrate to 'ossIndexAnalyzerPassword'",
1325+
Project.MSG_WARN);
13121326
this.ossindexAnalyzerPassword = ossindexAnalyzerPassword;
13131327
}
13141328

cli/src/main/java/org/owasp/dependencycheck/App.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -542,11 +542,19 @@ protected void populateSettings(CliParser cli) throws InvalidSettingException {
542542
String retireJsFilters = cli.getStringArgument(CliParser.ARGUMENT.RETIRE_JS_FILTERS);
543543
if (retireJsFilters == null) {
544544
retireJsFilters = cli.getStringArgument(CliParser.ARGUMENT.RETIREJS_FILTERS_DEPRECATED);
545+
if (retireJsFilters != null) {
546+
LOGGER.warn("'--{}' is deprecated and may be removed in the next major release, please migrate to '--{}'",
547+
CliParser.ARGUMENT.RETIREJS_FILTERS_DEPRECATED, CliParser.ARGUMENT.RETIRE_JS_FILTERS);
548+
}
545549
}
546550
settings.setStringIfNotNull(Settings.KEYS.ANALYZER_RETIREJS_FILTERS, retireJsFilters);
547551
Boolean retireJsFilterNonVuln = cli.hasOption(CliParser.ARGUMENT.RETIRE_JS_FILTER_NON_VULNERABLE);
548552
if (retireJsFilterNonVuln == null) {
549553
retireJsFilterNonVuln = cli.hasOption(CliParser.ARGUMENT.RETIREJS_FILTER_NON_VULNERABLE_DEPRECATED);
554+
if (retireJsFilterNonVuln != null) {
555+
LOGGER.warn("'--{}' is deprecated and may be removed in the next major release, please migrate to '--{}'",
556+
CliParser.ARGUMENT.RETIREJS_FILTER_NON_VULNERABLE_DEPRECATED, CliParser.ARGUMENT.RETIRE_JS_FILTER_NON_VULNERABLE);
557+
}
550558
}
551559
settings.setBooleanIfNotNull(Settings.KEYS.ANALYZER_RETIREJS_FILTER_NON_VULNERABLE, retireJsFilterNonVuln);
552560
settings.setBoolean(Settings.KEYS.ANALYZER_JAR_ENABLED,
@@ -624,6 +632,10 @@ protected void populateSettings(CliParser cli) throws InvalidSettingException {
624632
boolean retireJsDisabled = cli.isDisabled(CliParser.ARGUMENT.DISABLE_RETIRE_JS, Settings.KEYS.ANALYZER_RETIREJS_ENABLED);
625633
if (!retireJsDisabled) {
626634
retireJsDisabled = cli.isDisabled(CliParser.ARGUMENT.DISABLE_RETIREJS_DEPRECATED, Settings.KEYS.ANALYZER_RETIREJS_ENABLED);
635+
if (retireJsDisabled) {
636+
LOGGER.warn("'--{}' is deprecated and may be removed in the next major release, please migrate to '--{}'",
637+
CliParser.ARGUMENT.DISABLE_RETIREJS_DEPRECATED, CliParser.ARGUMENT.DISABLE_RETIRE_JS);
638+
}
627639
}
628640
settings.setBoolean(Settings.KEYS.ANALYZER_RETIREJS_ENABLED, !retireJsDisabled);
629641
settings.setBoolean(Settings.KEYS.ANALYZER_SWIFT_PACKAGE_MANAGER_ENABLED,

0 commit comments

Comments
 (0)