From bb9141c63012d0305ac65da763af3fb0c427076f Mon Sep 17 00:00:00 2001 From: Jan Srnicek Date: Wed, 30 Aug 2017 14:55:04 +0200 Subject: HONEYCOMB-389 - Static yang binding api and impl Also provides ignore option for default module list generation Change-Id: I9e10215491c964e6e88f90d6a3ad4335c94ec7d2 Signed-off-by: Jan Srnicek --- common/yang-whitelist/asciidoc/Readme.adoc | 33 +++++++++ common/yang-whitelist/pom.xml | 39 +++++++++++ .../yang-whitelist-api/asciidoc/Readme.adoc | 4 ++ common/yang-whitelist/yang-whitelist-api/pom.xml | 40 +++++++++++ .../src/main/java/io/fd/honeycomb/yang/Module.java | 78 +++++++++++++++++++++ .../io/fd/honeycomb/yang/YangModuleWhitelist.java | 49 +++++++++++++ .../yang-whitelist-impl/asciidoc/Readme.adoc | 3 + common/yang-whitelist/yang-whitelist-impl/pom.xml | 79 +++++++++++++++++++++ .../io/fd/honeycomb/yang/JAXBContextHolder.java | 37 ++++++++++ .../honeycomb/yang/YangModuleWhitelistReader.java | 53 ++++++++++++++ .../honeycomb/yang/YangModuleWhitelistWriter.java | 80 ++++++++++++++++++++++ .../yang/YangModuleWhitelistReaderTest.java | 56 +++++++++++++++ .../yang/YangModuleWhitelistWriterTest.java | 69 +++++++++++++++++++ .../src/test/resources/expected-whitelist.xml | 1 + 14 files changed, 621 insertions(+) create mode 100644 common/yang-whitelist/asciidoc/Readme.adoc create mode 100644 common/yang-whitelist/pom.xml create mode 100644 common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc create mode 100644 common/yang-whitelist/yang-whitelist-api/pom.xml create mode 100644 common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java create mode 100644 common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java create mode 100644 common/yang-whitelist/yang-whitelist-impl/asciidoc/Readme.adoc create mode 100644 common/yang-whitelist/yang-whitelist-impl/pom.xml create mode 100644 common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/JAXBContextHolder.java create mode 100644 common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistReader.java create mode 100644 common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistWriter.java create mode 100644 common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistReaderTest.java create mode 100644 common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistWriterTest.java create mode 100644 common/yang-whitelist/yang-whitelist-impl/src/test/resources/expected-whitelist.xml (limited to 'common/yang-whitelist') diff --git a/common/yang-whitelist/asciidoc/Readme.adoc b/common/yang-whitelist/asciidoc/Readme.adoc new file mode 100644 index 000000000..a3d752884 --- /dev/null +++ b/common/yang-whitelist/asciidoc/Readme.adoc @@ -0,0 +1,33 @@ += whitelist-aggregator + +Yang whitelist's are used to restrict list of modules that will be loaded to SchemaContext +per maven module. + +== Usage + +Two steps are required to use this feature. + + * Define ***.xml file that defines whitelist itself like so: + +[source,xml] +---- + + + + + Package name of YangModuleProvider class generated for respective yang model + General description for model + + ... + + +---- + + * Define *yang.modules.whitelist* property in you project pom + +[source,xml] +---- + + ${project.basedir}/src/main/resources/honeycomb-minimal-resources/config/restconf-whitelist.xml + +---- diff --git a/common/yang-whitelist/pom.xml b/common/yang-whitelist/pom.xml new file mode 100644 index 000000000..8e06790b1 --- /dev/null +++ b/common/yang-whitelist/pom.xml @@ -0,0 +1,39 @@ + + + + + + io.fd.honeycomb.common + honeycomb-parent + 1.17.10-SNAPSHOT + ../../common/honeycomb-parent + + + 4.0.0 + + io.fd.honeycomb.yang + yang-whitelist-aggregator + pom + + yang-whitelist-api + yang-whitelist-impl + + + + \ No newline at end of file diff --git a/common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc b/common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc new file mode 100644 index 000000000..d6047617c --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-api/asciidoc/Readme.adoc @@ -0,0 +1,4 @@ += whitelist-api + +Defines general api to whitelist list of yang modules that will be loaded to SchemaContext +per maven module \ No newline at end of file diff --git a/common/yang-whitelist/yang-whitelist-api/pom.xml b/common/yang-whitelist/yang-whitelist-api/pom.xml new file mode 100644 index 000000000..6d72a766d --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-api/pom.xml @@ -0,0 +1,40 @@ + + + + + + 4.0.0 + + io.fd.honeycomb.yang + yang-whitelist-api + 1.17.10-SNAPSHOT + + + 2.2.12 + + + + + javax.xml.bind + jaxb-api + ${jaxb-api.version} + + + + \ No newline at end of file diff --git a/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java new file mode 100644 index 000000000..0bedde8da --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/Module.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * 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. + */ + +package io.fd.honeycomb.yang; + +import java.util.Objects; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlTransient; + +public class Module { + + private String pckg; + private String description; + + @XmlElement(name = "package", required = true) + public String getPckg() { + return pckg; + } + + public void setPckg(final String pckg) { + // trims input name to eliminate formatted input + this.pckg = pckg.trim(); + } + + @XmlElement + public String getDescription() { + return description; + } + + public void setDescription(final String description) { + this.description = description; + } + + @XmlTransient + public String getBindingProviderName() { + return pckg + ".$YangModelBindingProvider"; + } + + @Override + public String toString() { + return "Module{" + + "pckg='" + pckg + '\'' + + ", description='" + description + '\'' + + '}'; + } + + @Override + public boolean equals(final Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + + final Module that = (Module) o; + + return Objects.equals(this.pckg, that.pckg) && Objects.equals(this.description, that.description); + } + + @Override + public int hashCode() { + return Objects.hash(pckg, description); + } +} diff --git a/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java new file mode 100644 index 000000000..fee6c396d --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-api/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelist.java @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * 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. + */ + +package io.fd.honeycomb.yang; + +import java.util.List; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlElementWrapper; +import javax.xml.bind.annotation.XmlRootElement; + +/** + * io.fd.aaa.bbb.ccc XYZ + * + */ +@XmlRootElement +public class YangModuleWhitelist { + + private List modules; + + public List getModules() { + return modules; + } + + @XmlElementWrapper(name = "modules") + @XmlElement(name = "module") + public void setModules(final List modules) { + this.modules = modules; + } + + @Override + public String toString() { + return "YangModuleWhitelist{" + + "modules=" + modules + + '}'; + } +} diff --git a/common/yang-whitelist/yang-whitelist-impl/asciidoc/Readme.adoc b/common/yang-whitelist/yang-whitelist-impl/asciidoc/Readme.adoc new file mode 100644 index 000000000..c5794045c --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/asciidoc/Readme.adoc @@ -0,0 +1,3 @@ += whitelist-impl + +Overview of whitelist-impl \ No newline at end of file diff --git a/common/yang-whitelist/yang-whitelist-impl/pom.xml b/common/yang-whitelist/yang-whitelist-impl/pom.xml new file mode 100644 index 000000000..0e1f02511 --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/pom.xml @@ -0,0 +1,79 @@ + + + + + + 4.0.0 + + io.fd.honeycomb.yang + yang-whitelist-impl + 1.17.10-SNAPSHOT + + + 2.2.11 + 1.7.25 + + + + + io.fd.honeycomb.yang + yang-whitelist-api + ${project.version} + + + org.glassfish.jaxb + jaxb-runtime + ${jaxb-runtime.version} + + + com.google.code.findbugs + jsr305 + 3.0.2 + + + org.slf4j + slf4j-api + ${slf4j-simple.version} + + + junit + junit + 4.12 + test + + + com.google.guava + guava + 19.0 + test + + + org.hamcrest + hamcrest-core + 1.3 + test + + + org.slf4j + slf4j-simple + ${slf4j-simple.version} + test + + + \ No newline at end of file diff --git a/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/JAXBContextHolder.java b/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/JAXBContextHolder.java new file mode 100644 index 000000000..ed1aee645 --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/JAXBContextHolder.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * 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. + */ + +package io.fd.honeycomb.yang; + +import javax.annotation.Nonnull; +import javax.xml.bind.JAXBContext; +import javax.xml.bind.JAXBException; + +abstract class JAXBContextHolder { + private final JAXBContext ctx; + + protected JAXBContextHolder(@Nonnull final Class... ctxClasses) { + try { + ctx = JAXBContext.newInstance(ctxClasses); + } catch (JAXBException e) { + throw new IllegalStateException("Unable to create JAXB context", e); + } + } + + protected JAXBContext getCtx() { + return ctx; + } +} diff --git a/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistReader.java b/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistReader.java new file mode 100644 index 000000000..f4897c275 --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistReader.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * 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. + */ + +package io.fd.honeycomb.yang; + +import static java.lang.String.format; + +import java.nio.file.Path; +import javax.annotation.Nonnull; +import javax.xml.bind.JAXBException; +import javax.xml.bind.Unmarshaller; + +public class YangModuleWhitelistReader extends JAXBContextHolder { + + public YangModuleWhitelistReader() { + super(YangModuleWhitelist.class); + } + + @Nonnull + public YangModuleWhitelist read(@Nonnull final Path path) { + final Unmarshaller unmarshaller = createUnmarshaller(); + return YangModuleWhitelist.class.cast(readWhitelist(path, unmarshaller)); + } + + private static Object readWhitelist(final Path path, final Unmarshaller unmarshaller) { + try { + return unmarshaller.unmarshal(path.toFile()); + } catch (JAXBException e) { + throw new IllegalStateException(format("Unable to read whitelist from %s", path), e); + } + } + + private Unmarshaller createUnmarshaller() { + try { + return getCtx().createUnmarshaller(); + } catch (JAXBException e) { + throw new IllegalStateException("Unable to create unmarshaller", e); + } + } +} diff --git a/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistWriter.java b/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistWriter.java new file mode 100644 index 000000000..d14b2428f --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/src/main/java/io/fd/honeycomb/yang/YangModuleWhitelistWriter.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * 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. + */ + +package io.fd.honeycomb.yang; + +import java.nio.file.Path; +import java.util.Objects; +import javax.annotation.Nonnull; +import javax.xml.bind.JAXBContext; +import javax.xml.bind.JAXBException; +import javax.xml.bind.Marshaller; +import javax.xml.bind.PropertyException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class YangModuleWhitelistWriter extends JAXBContextHolder { + + private static final Logger LOG = LoggerFactory.getLogger(YangModuleWhitelistWriter.class); + + public YangModuleWhitelistWriter() { + super(YangModuleWhitelist.class); + } + + /** + * Output serialized whitelist on specified path + * + * @param whitelist whitelist configuration + * @param outPath output path + */ + public void write(@Nonnull final YangModuleWhitelist whitelist, + @Nonnull final Path outPath, + final boolean formatOutput) { + Objects.requireNonNull(whitelist, "Cannot white null whitelist"); + // mashaller is not synchronized and lightweight, best practice is to create it per request(as opose to ctx, + // that should be created just once) + final Marshaller marshaller = createMarshaller(getCtx()); + setupPrettyPrint(marshaller, formatOutput); + whiteWhitelist(whitelist, outPath, marshaller); + } + + private static void whiteWhitelist(final YangModuleWhitelist whitelist, final Path outPath, + final Marshaller marshaller) { + try { + LOG.debug("Writing whitelist {} to file {}", whitelist, outPath); + marshaller.marshal(whitelist, outPath.toFile()); + LOG.debug("Whitelist successfully written to file {}", outPath); + } catch (JAXBException e) { + throw new IllegalStateException("Unable to write whitelist", e); + } + } + + private static void setupPrettyPrint(final Marshaller marshaller, final boolean value) { + try { + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, value); + } catch (PropertyException e) { + throw new IllegalStateException("Unable to setup pretty print"); + } + } + + private static Marshaller createMarshaller(final JAXBContext ctx) { + try { + return ctx.createMarshaller(); + } catch (JAXBException e) { + throw new IllegalStateException("Unable to create marshaller", e); + } + } +} diff --git a/common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistReaderTest.java b/common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistReaderTest.java new file mode 100644 index 000000000..6ab917a09 --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistReaderTest.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * 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. + */ + +package io.fd.honeycomb.yang; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertThat; + +import java.nio.file.Paths; +import java.util.List; +import org.hamcrest.CoreMatchers; +import org.junit.Before; +import org.junit.Test; + +public class YangModuleWhitelistReaderTest { + + private YangModuleWhitelistReader reader; + + @Before + public void init() throws Exception { + reader = new YangModuleWhitelistReader(); + } + + @Test + public void read() throws Exception { + final YangModuleWhitelist whitelist = reader.read( + Paths.get(this.getClass().getClassLoader().getResource("expected-whitelist.xml").getPath())); + + assertNotNull(whitelist); + final List modules = whitelist.getModules(); + assertEquals(2, modules.size()); + + final Module moduleA = new Module(); + final Module moduleB = new Module(); + moduleA.setPckg("module.a.package"); + moduleA.setDescription("desc"); + + moduleB.setPckg("module.b.package"); + + assertThat(modules, CoreMatchers.hasItems(moduleA, moduleB)); + } +} \ No newline at end of file diff --git a/common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistWriterTest.java b/common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistWriterTest.java new file mode 100644 index 000000000..c0ca170b8 --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/src/test/java/io/fd/honeycomb/yang/YangModuleWhitelistWriterTest.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * 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. + */ + +package io.fd.honeycomb.yang; + + +import static org.junit.Assert.assertEquals; + +import com.google.common.collect.ImmutableList; +import com.google.common.io.Resources; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.stream.Collectors; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +public class YangModuleWhitelistWriterTest { + + private YangModuleWhitelistWriter writer; + private Path path; + + @Before + public void init() throws IOException { + writer = new YangModuleWhitelistWriter(); + path = Files.createTempFile("tmp", "whitelist"); + } + + @Test + public void write() throws Exception { + final Module moduleA = new Module(); + final Module moduleB = new Module(); + moduleA.setPckg("module.a.package"); + moduleA.setDescription("desc"); + + moduleB.setPckg("module.b.package"); + + final YangModuleWhitelist whitelist = new YangModuleWhitelist(); + whitelist.setModules(ImmutableList.of(moduleA, moduleB)); + + writer.write(whitelist, path, false); + final String output = Files.readAllLines(path).stream().collect(Collectors.joining()); + final String expectedOutput = Resources + .toString(this.getClass().getClassLoader().getResource("expected-whitelist.xml"), + StandardCharsets.UTF_8); + assertEquals(expectedOutput, output); + } + + + @After + public void clean() { + path.toFile().delete(); + } +} \ No newline at end of file diff --git a/common/yang-whitelist/yang-whitelist-impl/src/test/resources/expected-whitelist.xml b/common/yang-whitelist/yang-whitelist-impl/src/test/resources/expected-whitelist.xml new file mode 100644 index 000000000..6ec5c22ae --- /dev/null +++ b/common/yang-whitelist/yang-whitelist-impl/src/test/resources/expected-whitelist.xml @@ -0,0 +1 @@ +descmodule.a.packagemodule.b.package \ No newline at end of file -- cgit 1.2.3-korg