From f5e347768e9503285c41346c646351c2bd3e11f5 Mon Sep 17 00:00:00 2001 From: Jan Srnicek Date: Mon, 9 Oct 2017 08:58:41 +0200 Subject: HONEYCOMB-393 - Introduce asciidoc-scripts && scripts-parent Change-Id: I15032951c52d25a3805c0348c8f400a935174eef Signed-off-by: Jan Srnicek --- common/asciidoc-scripts/pom.xml | 41 ++++++++++ .../common/scripts/AsciiDocImgForwarder.groovy | 44 ++++++++++ .../common/scripts/ReadmeGenerator.groovy | 61 ++++++++++++++ .../src/main/resources/readme/readmeDefaultContent | 3 + common/common-scripts/pom.xml | 60 ++------------ .../common/scripts/AsciiDocImgForwarder.groovy | 44 ---------- .../common/scripts/ReadmeGenerator.groovy | 61 -------------- .../src/main/resources/readme/readmeDefaultContent | 3 - common/honeycomb-parent/pom.xml | 6 +- common/pom.xml | 2 + common/scripts-parent/pom.xml | 95 ++++++++++++++++++++++ 11 files changed, 257 insertions(+), 163 deletions(-) create mode 100644 common/asciidoc-scripts/pom.xml create mode 100644 common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy create mode 100644 common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy create mode 100644 common/asciidoc-scripts/src/main/resources/readme/readmeDefaultContent delete mode 100644 common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy delete mode 100644 common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy delete mode 100644 common/common-scripts/src/main/resources/readme/readmeDefaultContent create mode 100644 common/scripts-parent/pom.xml diff --git a/common/asciidoc-scripts/pom.xml b/common/asciidoc-scripts/pom.xml new file mode 100644 index 000000000..6b276f4a7 --- /dev/null +++ b/common/asciidoc-scripts/pom.xml @@ -0,0 +1,41 @@ + + + + + + io.fd.honeycomb.scripts + scripts-parent + 1.18.01-SNAPSHOT + ../scripts-parent + + + 4.0.0 + + io.fd.honeycomb.doc + asciidoc-scripts + 1.18.01-SNAPSHOT + ${project.artifactId} + + + + org.codehaus.groovy + groovy-all + + + \ No newline at end of file diff --git a/common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy b/common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy new file mode 100644 index 000000000..5bdf0cd32 --- /dev/null +++ b/common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2016 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.common.scripts + +import java.nio.file.Files +import java.nio.file.Paths + +class AsciiDocImgForwarder { + + static final def ADOC_FOLDER = "asciidoc" + static final def SITE_FOLDER = "site" + static final def PNG_EXTENSION = "png"; + + /** + * Copies generated images to site folder + * */ + public static void copyGeneratedImages(project, properties, log){ + + def sourcePath = Paths.get(project.basedir.toString(), ADOC_FOLDER) + def destinationPathString = Paths.get(project.build.directory.toString(), SITE_FOLDER).toString() + + log.info "Copying generated asciidoc images from ${sourcePath} to ${destinationPathString}" + Files.walk(sourcePath) + .filter({ path -> path.toString().endsWith(PNG_EXTENSION) }) + .forEach({ sourceFilePath -> + def targetFilePath = Paths.get(destinationPathString, sourceFilePath.getFileName().toString()) + log.info "Copying ${sourceFilePath} to ${targetFilePath}" + Files.copy(sourceFilePath, targetFilePath) }) + } +} diff --git a/common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy b/common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy new file mode 100644 index 000000000..6bab620c7 --- /dev/null +++ b/common/asciidoc-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy @@ -0,0 +1,61 @@ +/* + * 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.common.scripts + +import groovy.text.SimpleTemplateEngine + +import java.nio.file.Files +import java.nio.file.Paths + +/** + * Check/generate and repair Readme.adoc for a honeycomb module. + */ +class ReadmeGenerator { + + static final def DEFAULT_README = ReadmeGenerator.getResource("/readme/readmeDefaultContent").text + + static final def ADOC_FOLDER = "asciidoc" + static final def README = "Readme" + static final def README_FILE = "${README}.adoc" + static final def README_HTML = "${README}.html" + static final def SITE_FOLDER = "site" + static final def INDEX_HTML = "index.html" + + public static void checkReadme(project, properties, log) { + log.info "Checking ${ADOC_FOLDER}/${README_FILE}" + def asciidoc = Paths.get(project.getBasedir().toString(), ADOC_FOLDER) + def readme = Paths.get(asciidoc.toString(), README_FILE) + if (!Files.exists(readme)) { + log.info "Generating ${readme}" + Files.createDirectories(asciidoc) + Files.createFile(readme) + readme.toFile().text = new SimpleTemplateEngine().createTemplate(DEFAULT_README) + .make(["artifactId": project.artifactId]) + .toString() + } + } + + public static void fixSite(project, properties, log) { + def index = Paths.get(project.build.directory.toString(), SITE_FOLDER, INDEX_HTML) + if (Files.exists(index)) { + log.info "Fixing links in generated site" + def html = index.toFile().text + log.info "Fixing ${ADOC_FOLDER} ${README_HTML} link" + index.toFile().text = html.replaceAll("[./]*${README}\\.html", README_HTML) + } + } +} diff --git a/common/asciidoc-scripts/src/main/resources/readme/readmeDefaultContent b/common/asciidoc-scripts/src/main/resources/readme/readmeDefaultContent new file mode 100644 index 000000000..b50837275 --- /dev/null +++ b/common/asciidoc-scripts/src/main/resources/readme/readmeDefaultContent @@ -0,0 +1,3 @@ += ${artifactId} + +Overview of ${artifactId} \ No newline at end of file diff --git a/common/common-scripts/pom.xml b/common/common-scripts/pom.xml index cc78e816c..3de8e3c9d 100644 --- a/common/common-scripts/pom.xml +++ b/common/common-scripts/pom.xml @@ -18,6 +18,13 @@ + + io.fd.honeycomb.scripts + scripts-parent + 1.18.01-SNAPSHOT + ../scripts-parent + + 4.0.0 io.fd.honeycomb.common common-scripts @@ -26,68 +33,17 @@ jar - - 2.0 - 2.4.7 - 2.9.2-01 - 2.4.3-01 2.5 - 0.10.1-Carbon - - - - - org.apache.maven.plugins - maven-site-plugin - - true - true - - - - - - - org.codehaus.groovy - groovy-eclipse-compiler - ${groovy.eclipse.compiler.version} - true - - - maven-compiler-plugin - - - groovy-eclipse-compiler - - - - org.codehaus.groovy - groovy-eclipse-compiler - ${groovy.eclipse.compiler.version} - - - - org.codehaus.groovy - groovy-eclipse-batch - ${groovy.eclipse.batch.version} - - - - - - org.codehaus.groovy groovy-all - ${groovy.version} org.opendaylight.mdsal yang-binding - ${yang-binding.version} commons-io @@ -97,7 +53,7 @@ io.fd.honeycomb.yang yang-whitelist-impl - 1.18.01-SNAPSHOT + ${project.version} diff --git a/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy b/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy deleted file mode 100644 index 5bdf0cd32..000000000 --- a/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/AsciiDocImgForwarder.groovy +++ /dev/null @@ -1,44 +0,0 @@ -/* - * Copyright (c) 2016 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.common.scripts - -import java.nio.file.Files -import java.nio.file.Paths - -class AsciiDocImgForwarder { - - static final def ADOC_FOLDER = "asciidoc" - static final def SITE_FOLDER = "site" - static final def PNG_EXTENSION = "png"; - - /** - * Copies generated images to site folder - * */ - public static void copyGeneratedImages(project, properties, log){ - - def sourcePath = Paths.get(project.basedir.toString(), ADOC_FOLDER) - def destinationPathString = Paths.get(project.build.directory.toString(), SITE_FOLDER).toString() - - log.info "Copying generated asciidoc images from ${sourcePath} to ${destinationPathString}" - Files.walk(sourcePath) - .filter({ path -> path.toString().endsWith(PNG_EXTENSION) }) - .forEach({ sourceFilePath -> - def targetFilePath = Paths.get(destinationPathString, sourceFilePath.getFileName().toString()) - log.info "Copying ${sourceFilePath} to ${targetFilePath}" - Files.copy(sourceFilePath, targetFilePath) }) - } -} diff --git a/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy b/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy deleted file mode 100644 index 5010395ea..000000000 --- a/common/common-scripts/src/main/groovy/io/fd/honeycomb/common/scripts/ReadmeGenerator.groovy +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Copyright (c) 2016 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.common.scripts - -import groovy.text.SimpleTemplateEngine - -import java.nio.file.Files -import java.nio.file.Paths - -/** - * Check/generate and repair Readme.adoc for a honeycomb module. - */ -class ReadmeGenerator { - - static final def DEFAULT_README = ModulesListGenerator.getResource("/readme/readmeDefaultContent").text - - static final def ADOC_FOLDER = "asciidoc" - static final def README = "Readme" - static final def README_FILE = "${README}.adoc" - static final def README_HTML = "${README}.html" - static final def SITE_FOLDER = "site" - static final def INDEX_HTML = "index.html" - - public static void checkReadme(project, properties, log) { - log.info "Checking ${ADOC_FOLDER}/${README_FILE}" - def asciidoc = Paths.get(project.getBasedir().toString(), ADOC_FOLDER) - def readme = Paths.get(asciidoc.toString(), README_FILE) - if (!Files.exists(readme)) { - log.info "Generating ${readme}" - Files.createDirectories(asciidoc) - Files.createFile(readme) - readme.toFile().text = new SimpleTemplateEngine().createTemplate(DEFAULT_README) - .make(["artifactId": project.artifactId]) - .toString() - } - } - - public static void fixSite(project, properties, log) { - def index = Paths.get(project.build.directory.toString(), SITE_FOLDER, INDEX_HTML) - if (Files.exists(index)) { - log.info "Fixing links in generated site" - def html = index.toFile().text - log.info "Fixing ${ADOC_FOLDER} ${README_HTML} link" - index.toFile().text = html.replaceAll("[./]*${README}\\.html", README_HTML) - } - } -} diff --git a/common/common-scripts/src/main/resources/readme/readmeDefaultContent b/common/common-scripts/src/main/resources/readme/readmeDefaultContent deleted file mode 100644 index b50837275..000000000 --- a/common/common-scripts/src/main/resources/readme/readmeDefaultContent +++ /dev/null @@ -1,3 +0,0 @@ -= ${artifactId} - -Overview of ${artifactId} \ No newline at end of file diff --git a/common/honeycomb-parent/pom.xml b/common/honeycomb-parent/pom.xml index df2eb8045..878db263f 100644 --- a/common/honeycomb-parent/pom.xml +++ b/common/honeycomb-parent/pom.xml @@ -524,9 +524,9 @@ - io.fd.honeycomb.common - common-scripts - 1.18.01-SNAPSHOT + io.fd.honeycomb.doc + asciidoc-scripts + ${project.version} diff --git a/common/pom.xml b/common/pom.xml index 5c6805af5..683cb3875 100644 --- a/common/pom.xml +++ b/common/pom.xml @@ -38,6 +38,8 @@ minimal-assembly-descriptor minimal-distribution-parent yang-whitelist + asciidoc-scripts + scripts-parent diff --git a/common/scripts-parent/pom.xml b/common/scripts-parent/pom.xml new file mode 100644 index 000000000..acba2cf3e --- /dev/null +++ b/common/scripts-parent/pom.xml @@ -0,0 +1,95 @@ + + + + + 4.0.0 + + io.fd.honeycomb.scripts + scripts-parent + 1.18.01-SNAPSHOT + pom + ${project.artifactId} + + + + 2.0 + 2.4.7 + 2.9.2-01 + 2.4.3-01 + 0.10.1-Carbon + + + + + + org.codehaus.groovy + groovy-all + ${groovy.version} + + + org.opendaylight.mdsal + yang-binding + ${yang-binding.version} + + + + + + + + + org.apache.maven.plugins + maven-site-plugin + + true + true + + + + + + + org.codehaus.groovy + groovy-eclipse-compiler + ${groovy.eclipse.compiler.version} + true + + + maven-compiler-plugin + + + groovy-eclipse-compiler + + + + org.codehaus.groovy + groovy-eclipse-compiler + ${groovy.eclipse.compiler.version} + + + + org.codehaus.groovy + groovy-eclipse-batch + ${groovy.eclipse.batch.version} + + + + + + \ No newline at end of file -- cgit 1.2.3-korg