diff options
17 files changed, 631 insertions, 1 deletions
diff --git a/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ModuleYangIndexGenerator.groovy b/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ModuleYangIndexGenerator.groovy index 042ce6132..8e4c38824 100644 --- a/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ModuleYangIndexGenerator.groovy +++ b/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ModuleYangIndexGenerator.groovy @@ -50,6 +50,12 @@ class ModuleYangIndexGenerator { private static final YANG_MODULES_INDEX_FILE_NAME = "yang-modules-index" public static void generateIndexForPresentModules(project, log) { + String skip = project.getProperties().get("skip.module.list.generation") + if (Boolean.parseBoolean(skip)) { + log.info "Skipping yang modules list generation for project ${project.getName()}" + return + } + log.info "Checking module providers for project ${project.getName()}" // checks module provides from dependencies // folder with extracted libs @@ -59,7 +65,7 @@ class ModuleYangIndexGenerator { // therefore it will run also for parent, that does not have any depedencies(just dep management) // so lib folder wont be created log.info "Folder ${libsFolder} does not exist - No dependencies to process" - return; + return } String yangModules = java.nio.file.Files.walk(libsFolder) diff --git a/common/pom.xml b/common/pom.xml index 588955be6..234bdf295 100644 --- a/common/pom.xml +++ b/common/pom.xml @@ -37,6 +37,7 @@ <module>impl-parent</module> <module>minimal-assembly-descriptor</module> <module>minimal-distribution-parent</module> + <module>yang-whitelist</module> </modules> <!-- DO NOT install or deploy the repo root pom as it's only needed to initiate a build --> 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] +---- +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<yangModuleWhitelist> + <modules> + <module> + <package>Package name of YangModuleProvider class generated for respective yang model</package> + <description>General description for model</description> + </module> + ... + </modules> +</yangModuleWhitelist> +---- + + * Define *yang.modules.whitelist* property in you project pom + +[source,xml] +---- +<yang.modules.whitelist> + ${project.basedir}/src/main/resources/honeycomb-minimal-resources/config/restconf-whitelist.xml +</yang.modules.whitelist> +---- 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 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ~ 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. + --> + +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <parent> + <groupId>io.fd.honeycomb.common</groupId> + <artifactId>honeycomb-parent</artifactId> + <version>1.17.10-SNAPSHOT</version> + <relativePath>../../common/honeycomb-parent</relativePath> + </parent> + + <modelVersion>4.0.0</modelVersion> + + <groupId>io.fd.honeycomb.yang</groupId> + <artifactId>yang-whitelist-aggregator</artifactId> + <packaging>pom</packaging> + <modules> + <module>yang-whitelist-api</module> + <module>yang-whitelist-impl</module> + </modules> + + +</project>
\ 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 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ~ 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. + --> + +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <!-- Cannot have parent , to break cycle, its used in build --> + <modelVersion>4.0.0</modelVersion> + + <groupId>io.fd.honeycomb.yang</groupId> + <artifactId>yang-whitelist-api</artifactId> + <version>1.17.10-SNAPSHOT</version> + + <properties> + <jaxb-api.version>2.2.12</jaxb-api.version> + </properties> + + <dependencies> + <dependency> + <groupId>javax.xml.bind</groupId> + <artifactId>jaxb-api</artifactId> + <version>${jaxb-api.version}</version> + </dependency> + </dependencies> + +</project>
\ 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; + +/** + * <yang-modules-whitelist> <modules> <module> <package>io.fd.aaa.bbb.ccc</package> <description>XYZ</description> + * </module> </modules> </yang-modules-whitelist> + */ +@XmlRootElement +public class YangModuleWhitelist { + + private List<Module> modules; + + public List<Module> getModules() { + return modules; + } + + @XmlElementWrapper(name = "modules") + @XmlElement(name = "module") + public void setModules(final List<Module> 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 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ~ 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. + --> + +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <!-- Cannot have parent , to break cycle, its used in build --> + <modelVersion>4.0.0</modelVersion> + + <groupId>io.fd.honeycomb.yang</groupId> + <artifactId>yang-whitelist-impl</artifactId> + <version>1.17.10-SNAPSHOT</version> + + <properties> + <jaxb-runtime.version>2.2.11</jaxb-runtime.version> + <slf4j-simple.version>1.7.25</slf4j-simple.version> + </properties> + + <dependencies> + <dependency> + <groupId>io.fd.honeycomb.yang</groupId> + <artifactId>yang-whitelist-api</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.glassfish.jaxb</groupId> + <artifactId>jaxb-runtime</artifactId> + <version>${jaxb-runtime.version}</version> + </dependency> + <dependency> + <groupId>com.google.code.findbugs</groupId> + <artifactId>jsr305</artifactId> + <version>3.0.2</version> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-api</artifactId> + <version>${slf4j-simple.version}</version> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <version>4.12</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>com.google.guava</groupId> + <artifactId>guava</artifactId> + <version>19.0</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.hamcrest</groupId> + <artifactId>hamcrest-core</artifactId> + <version>1.3</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-simple</artifactId> + <version>${slf4j-simple.version}</version> + <scope>test</scope> + </dependency> + </dependencies> +</project>
\ 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<Module> 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 @@ +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><yangModuleWhitelist><modules><module><description>desc</description><package>module.a.package</package></module><module><package>module.b.package</package></module></modules></yangModuleWhitelist>
\ No newline at end of file diff --git a/infra/minimal-distribution-core/pom.xml b/infra/minimal-distribution-core/pom.xml index 4e74dc481..fb2541c4d 100644 --- a/infra/minimal-distribution-core/pom.xml +++ b/infra/minimal-distribution-core/pom.xml @@ -34,6 +34,8 @@ <properties> <commons-io.version>2.5</commons-io.version> <osgi.core.version>5.0.0</osgi.core.version> + <!-- Core guice modules does not need any yang modules itself --> + <skip.module.list.generation>true</skip.module.list.generation> </properties> <dependencies> |