You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2020/11/20 14:22:48 UTC
[sling-org-apache-sling-feature-extension-apiregions] branch
SLING-9867 updated: Add simple analyser for configuration api
This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch SLING-9867
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-extension-apiregions.git
The following commit(s) were added to refs/heads/SLING-9867 by this push:
new 362a192 Add simple analyser for configuration api
362a192 is described below
commit 362a192f917e40406f62c4c26bbc816fe22ada13
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Fri Nov 20 15:22:18 2020 +0100
Add simple analyser for configuration api
---
pom.xml | 2 +-
.../apiregions/analyser/CheckConfigurationApi.java | 88 ++++++++++++++++++++++
...apache.sling.feature.analyser.task.AnalyserTask | 1 +
3 files changed, 90 insertions(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index 5b2e7a0..ada7b63 100644
--- a/pom.xml
+++ b/pom.xml
@@ -62,7 +62,7 @@
<dependency>
<groupId>org.apache.sling</groupId>
<artifactId>org.apache.sling.feature.analyser</artifactId>
- <version>1.3.8</version>
+ <version>1.3.12</version>
<scope>provided</scope>
</dependency>
<dependency>
diff --git a/src/main/java/org/apache/sling/feature/extension/apiregions/analyser/CheckConfigurationApi.java b/src/main/java/org/apache/sling/feature/extension/apiregions/analyser/CheckConfigurationApi.java
new file mode 100644
index 0000000..20a5d6c
--- /dev/null
+++ b/src/main/java/org/apache/sling/feature/extension/apiregions/analyser/CheckConfigurationApi.java
@@ -0,0 +1,88 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.sling.feature.extension.apiregions.analyser;
+
+import java.util.Map;
+
+import org.apache.sling.feature.analyser.task.AnalyserTask;
+import org.apache.sling.feature.analyser.task.AnalyserTaskContext;
+import org.apache.sling.feature.extension.apiregions.api.config.ConfigurationApi;
+import org.apache.sling.feature.extension.apiregions.api.config.validation.ConfigurationValidationResult;
+import org.apache.sling.feature.extension.apiregions.api.config.validation.FeatureValidationResult;
+import org.apache.sling.feature.extension.apiregions.api.config.validation.FeatureValidator;
+import org.apache.sling.feature.extension.apiregions.api.config.validation.PropertyValidationResult;
+
+
+public class CheckConfigurationApi implements AnalyserTask{
+
+ @Override
+ public String getId() {
+ return "configuration-api";
+ }
+
+ @Override
+ public String getName() {
+ return "Configuration API analyser task";
+ }
+
+ @Override
+ public void execute(final AnalyserTaskContext context) throws Exception {
+ final FeatureValidator validator = new FeatureValidator();
+ validator.setFeatureProvider(context.getFeatureProvider());
+
+ final ConfigurationApi api = ConfigurationApi.getConfigurationApi(context.getFeature());
+ if ( api == null ) {
+ context.reportExtensionWarning(ConfigurationApi.EXTENSION_NAME, "Configuration api is not specified, unable to validate feature");
+ } else {
+ final FeatureValidationResult result = validator.validate(context.getFeature(), api);
+ if ( !result.isValid() ) {
+ for(final Map.Entry<String, PropertyValidationResult> entry : result.getFrameworkPropertyResults().entrySet()) {
+ for(final String warn : entry.getValue().getWarnings()) {
+ context.reportWarning("Framework property " + entry.getKey() + " : " + warn);
+ }
+ if ( !entry.getValue().isValid() ) {
+ for(final String err : entry.getValue().getErrors()) {
+ context.reportError("Framework property " + entry.getKey() + " : " + err);
+ }
+ }
+ }
+ for(final Map.Entry<String, ConfigurationValidationResult> entry : result.getConfigurationResults().entrySet()) {
+ for(final String warn : entry.getValue().getWarnings()) {
+ context.reportWarning("Configuration " + entry.getKey() + " : " + warn);
+ }
+ for(final Map.Entry<String, PropertyValidationResult> propEntry : entry.getValue().getPropertyResults().entrySet()) {
+ for(final String warn : propEntry.getValue().getWarnings()) {
+ context.reportWarning("Configuration " + entry.getKey() + "." + propEntry.getKey() + " : " + warn);
+ }
+ }
+ if ( !entry.getValue().isValid() ) {
+ for(final String err : entry.getValue().getGlobalErrors()) {
+ context.reportError("Configuration " + entry.getKey() + " : " + err);
+ }
+ for(final Map.Entry<String, PropertyValidationResult> propEntry : entry.getValue().getPropertyResults().entrySet()) {
+ if ( !propEntry.getValue().isValid() ) {
+ for(final String err : propEntry.getValue().getErrors()) {
+ context.reportWarning("Configuration " + entry.getKey() + "." + propEntry.getKey() + " : " + err);
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/src/main/resources/META-INF/services/org.apache.sling.feature.analyser.task.AnalyserTask b/src/main/resources/META-INF/services/org.apache.sling.feature.analyser.task.AnalyserTask
index 0744c72..c2f9f10 100644
--- a/src/main/resources/META-INF/services/org.apache.sling.feature.analyser.task.AnalyserTask
+++ b/src/main/resources/META-INF/services/org.apache.sling.feature.analyser.task.AnalyserTask
@@ -4,3 +4,4 @@ org.apache.sling.feature.extension.apiregions.analyser.CheckApiRegionsDuplicates
org.apache.sling.feature.extension.apiregions.analyser.CheckApiRegionsOrder
org.apache.sling.feature.extension.apiregions.analyser.CheckApiRegionsBundleExportsImports
org.apache.sling.feature.extension.apiregions.analyser.CheckApiRegionsCrossFeatureDups
+org.apache.sling.feature.extension.apiregions.analyser.CheckConfigurationApi
\ No newline at end of file