From 32fb53c13342d5ad353c839b7ffd0ca85d14bd48 Mon Sep 17 00:00:00 2001 From: Jessica Wagantall Date: Tue, 1 Dec 2020 11:48:20 -0800 Subject: Migrate sli-core files Migrate sli-core repo files into new directory "core". Signed-off-by: Jessica Wagantall --- core/filters/.gitignore | 34 ++++++ core/filters/.sonar/checkstyle.xml | 1 + core/filters/.sonar/pmd.xml | 67 +++++++++++ core/filters/README | 14 +++ core/filters/installer/pom.xml | 126 +++++++++++++++++++++ .../src/assembly/assemble_installer_zip.xml | 61 ++++++++++ .../src/assembly/assemble_mvnrepo_zip.xml | 49 ++++++++ .../src/main/resources/scripts/install-feature.sh | 39 +++++++ core/filters/pom.xml | 27 +++++ core/filters/provider/pom.xml | 29 +++++ .../sli/core/filters/ControllerAuditLogFilter.java | 40 +++++++ .../filters/ControllerPayloadLoggingFilter.java | 7 ++ .../core/filters/ControllerAuditLogFilterTest.java | 23 ++++ 13 files changed, 517 insertions(+) create mode 100755 core/filters/.gitignore create mode 100755 core/filters/.sonar/checkstyle.xml create mode 100755 core/filters/.sonar/pmd.xml create mode 100755 core/filters/README create mode 100755 core/filters/installer/pom.xml create mode 100644 core/filters/installer/src/assembly/assemble_installer_zip.xml create mode 100644 core/filters/installer/src/assembly/assemble_mvnrepo_zip.xml create mode 100644 core/filters/installer/src/main/resources/scripts/install-feature.sh create mode 100644 core/filters/pom.xml create mode 100755 core/filters/provider/pom.xml create mode 100644 core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilter.java create mode 100644 core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerPayloadLoggingFilter.java create mode 100644 core/filters/provider/src/test/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilterTest.java (limited to 'core/filters') diff --git a/core/filters/.gitignore b/core/filters/.gitignore new file mode 100755 index 000000000..b73caf31e --- /dev/null +++ b/core/filters/.gitignore @@ -0,0 +1,34 @@ +#####standard .git ignore entries##### + +## IDE Specific Files ## +org.eclipse.core.resources.prefs +.classpath +.project +.settings +.idea +.externalToolBuilders +maven-eclipse.xml +workspace + +## Compilation Files ## +*.class +**/target +target +target-ide +MANIFEST.MF + +## Misc Ignores (OS specific etc) ## +bin/ +dist +*~ +*.ipr +*.iml +*.iws +classes +out/ +.DS_STORE +.metadata + +## Folders which contain auto generated source code ## +yang-gen-config +yang-gen-sal diff --git a/core/filters/.sonar/checkstyle.xml b/core/filters/.sonar/checkstyle.xml new file mode 100755 index 000000000..3fa231535 --- /dev/null +++ b/core/filters/.sonar/checkstyle.xml @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/core/filters/.sonar/pmd.xml b/core/filters/.sonar/pmd.xml new file mode 100755 index 000000000..80343b3bd --- /dev/null +++ b/core/filters/.sonar/pmd.xml @@ -0,0 +1,67 @@ + + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 2 + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 3 + + + 5 + + + 2 + + + 3 + + + 3 + + + diff --git a/core/filters/README b/core/filters/README new file mode 100755 index 000000000..5c1b3d627 --- /dev/null +++ b/core/filters/README @@ -0,0 +1,14 @@ + +/restconf filters are enabled by specifying filter chain in + /opt/opendaylight/current/etc/org.opendaylight.aaa.filterchain.cfg +and enabling bundle class loading + >bundle:dynamic-import org.onap.ccsdk.sli.core.filters-provider + +loggers: + org.onap.ccsdk.sli.core.filters.audit + org.onap.ccsdk.sli.core.filters.metric + org.onap.ccsdk.sli.core.filters.request.response + + + + diff --git a/core/filters/installer/pom.xml b/core/filters/installer/pom.xml new file mode 100755 index 000000000..fae31a12b --- /dev/null +++ b/core/filters/installer/pom.xml @@ -0,0 +1,126 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + odlparent-lite + 2.1.0-SNAPSHOT + + + + org.onap.ccsdk.sli.core + filters-installer + 1.1.1-SNAPSHOT + pom + + ccsdk-sli-core :: filters :: ${project.artifactId} + + + ccsdk-filters + ${application.name} + mvn:org.onap.ccsdk.sli.core/${features.boot}/${project.version}/xml/features + false + + + + + org.onap.ccsdk.sli.core + filters-provider + ${project.version} + + + + + + + maven-assembly-plugin + + + maven-repo-zip + + single + + package + + true + stage/${application.name}-${project.version} + + src/assembly/assemble_mvnrepo_zip.xml + + true + + + + installer-zip + + single + + package + + true + ${application.name}-${project.version}-installer + + src/assembly/assemble_installer_zip.xml + + false + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + copy-dependencies + + copy-dependencies + + prepare-package + + false + ${project.build.directory}/assembly/system + false + true + true + true + false + false + org.onap.ccsdk.sli.core + sli-common,sli-provider,utils-provider,dblib-provider + provided + + + + + + maven-resources-plugin + 2.6 + + + copy-version + + copy-resources + + validate + + ${basedir}/target/stage + + + src/main/resources/scripts + + install-feature.sh + + true + + + + + + + + + + + diff --git a/core/filters/installer/src/assembly/assemble_installer_zip.xml b/core/filters/installer/src/assembly/assemble_installer_zip.xml new file mode 100644 index 000000000..2ff550d2c --- /dev/null +++ b/core/filters/installer/src/assembly/assemble_installer_zip.xml @@ -0,0 +1,61 @@ + + + + + + + bin + + + zip + + + + false + + + + target/stage/ + ${application.name} + 755 + + *.sh + + + + target/stage/ + ${application.name} + 644 + + *.sh + + + + + + + diff --git a/core/filters/installer/src/assembly/assemble_mvnrepo_zip.xml b/core/filters/installer/src/assembly/assemble_mvnrepo_zip.xml new file mode 100644 index 000000000..69e9e2909 --- /dev/null +++ b/core/filters/installer/src/assembly/assemble_mvnrepo_zip.xml @@ -0,0 +1,49 @@ + + + + + + repo + + zip + + + + false + + + + target/assembly/ + . + + + + + + + + diff --git a/core/filters/installer/src/main/resources/scripts/install-feature.sh b/core/filters/installer/src/main/resources/scripts/install-feature.sh new file mode 100644 index 000000000..74b95b5c8 --- /dev/null +++ b/core/filters/installer/src/main/resources/scripts/install-feature.sh @@ -0,0 +1,39 @@ +#!/bin/bash + +### +# ============LICENSE_START======================================================= +# ONAP : CCSDK +# ================================================================================ +# Copyright (C) 2017 AT&T Intellectual Property. All rights +# reserved. +# ================================================================================ +# Licensed 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. +# ============LICENSE_END========================================================= +### + +ODL_HOME=${ODL_HOME:-/opt/opendaylight/current} +ODL_KARAF_CLIENT=${ODL_KARAF_CLIENT:-${ODL_HOME}/bin/client} +INSTALLERDIR=$(dirname $0) + +REPOZIP=${INSTALLERDIR}/${features.boot}-${project.version}.zip + +if [ -f ${REPOZIP} ] +then + unzip -d ${ODL_HOME} ${REPOZIP} +else + echo "ERROR : repo zip ($REPOZIP) not found" + exit 1 +fi + +${ODL_KARAF_CLIENT} feature:repo-add ${features.repositories} +${ODL_KARAF_CLIENT} feature:install ${features.boot} diff --git a/core/filters/pom.xml b/core/filters/pom.xml new file mode 100644 index 000000000..8db5d810b --- /dev/null +++ b/core/filters/pom.xml @@ -0,0 +1,27 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + odlparent-lite + 2.1.0-SNAPSHOT + + + + org.onap.ccsdk.sli.core + filters + 1.1.1-SNAPSHOT + pom + + ccsdk-sli-core :: filters + Servlet filter to implement ONAP logging spec + + ONAP + + + + provider + installer + + diff --git a/core/filters/provider/pom.xml b/core/filters/provider/pom.xml new file mode 100755 index 000000000..ea7f9962e --- /dev/null +++ b/core/filters/provider/pom.xml @@ -0,0 +1,29 @@ + + + 4.0.0 + + + org.onap.ccsdk.parent + binding-parent + 2.1.0-SNAPSHOT + + + + org.onap.ccsdk.sli.core + filters-provider + 1.1.1-SNAPSHOT + bundle + + ccsdk-sli-core :: filters :: ${project.artifactId} + + + + org.onap.logging-analytics + logging-filter-base + + + javax.servlet + javax.servlet-api + + + diff --git a/core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilter.java b/core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilter.java new file mode 100644 index 000000000..7805e365d --- /dev/null +++ b/core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilter.java @@ -0,0 +1,40 @@ +package org.onap.ccsdk.sli.core.filters; + +import javax.servlet.http.HttpServletRequest; +import org.onap.logging.filter.base.AuditLogServletFilter; +import org.onap.logging.ref.slf4j.ONAPLogConstants; +import org.slf4j.MDC; + +public class ControllerAuditLogFilter extends AuditLogServletFilter { + private static final String MDC_HTTP_METHOD_KEY = "HttpMethod"; + + @Override + protected void additionalPreHandling(HttpServletRequest httpServletRequest) { + // Don't overwrite service instance id if it was set outside of this automated method + if (MDC.get(ONAPLogConstants.MDCs.SERVICE_INSTANCE_ID) == null) { + String serviceInstanceId = getServiceInstanceId(httpServletRequest.getPathInfo()); + if (serviceInstanceId != null) { + MDC.put(ONAPLogConstants.MDCs.SERVICE_INSTANCE_ID, serviceInstanceId); + } + } + MDC.put(MDC_HTTP_METHOD_KEY, httpServletRequest.getMethod()); + } + + // restconf URLs follow a pattern, this method attempts to extract the service instance id according to that pattern + protected String getServiceInstanceId(String path) { + int idx = path.indexOf("service-list"); + if (idx != -1) { + // chomp off service-list/ + String str = path.substring(idx + 13); + idx = str.indexOf("/"); + //if there is another forward slash with more information chomp it off + if (idx != -1) { + return str.substring(0, idx); + } else { + return str; + } + } + return null; + } + +} diff --git a/core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerPayloadLoggingFilter.java b/core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerPayloadLoggingFilter.java new file mode 100644 index 000000000..3f9f93fc5 --- /dev/null +++ b/core/filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/ControllerPayloadLoggingFilter.java @@ -0,0 +1,7 @@ +package org.onap.ccsdk.sli.core.filters; + +import org.onap.logging.filter.base.PayloadLoggingServletFilter; + +public class ControllerPayloadLoggingFilter extends PayloadLoggingServletFilter { + +} diff --git a/core/filters/provider/src/test/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilterTest.java b/core/filters/provider/src/test/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilterTest.java new file mode 100644 index 000000000..9d0357a96 --- /dev/null +++ b/core/filters/provider/src/test/java/org/onap/ccsdk/sli/core/filters/ControllerAuditLogFilterTest.java @@ -0,0 +1,23 @@ +package org.onap.ccsdk.sli.core.filters; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; + +public class ControllerAuditLogFilterTest { + + @Test + public void getSimpleSiid() throws Exception { + ControllerAuditLogFilter filter = new ControllerAuditLogFilter(); + String siid = filter.getServiceInstanceId("/restconf/config/Layer3API:services/service-list/100"); + assertEquals("100", siid); + } + + @Test + public void getSimpleComplexSiid() throws Exception { + ControllerAuditLogFilter filter = new ControllerAuditLogFilter(); + String siid = filter.getServiceInstanceId( + "/restconf/config/Layer3API:services/service-list/1337/service-data/oper-status"); + assertEquals("1337", siid); + } + +} -- cgit 1.2.3-korg