summaryrefslogtreecommitdiffstats
path: root/check-blueprint-vs-input
diff options
context:
space:
mode:
authorTony Hansen <tony@att.com>2017-09-29 02:03:39 +0000
committerTony Hansen <tony@att.com>2017-09-29 02:03:53 +0000
commit16a1fcbc814ec20e59cbe95cb506bca29f104208 (patch)
treefaef0c5a6b382a22943f35774f8469f75d0e2b88 /check-blueprint-vs-input
parent8cdeeeb9a2e8b51f9897173dc26d672e55b00304 (diff)
remove check-blueprint-vs-input, repackage
check-blueprint-vs-input was moved to blueprints module repackage was moved to ccsdk/pgaas module Change-Id: If9d04d4ee1c0e5a3a2b837fc253c00dee226a2ac Signed-off-by: Tony Hansen <tony@att.com> Issue-ID: DCAEGEN2-49
Diffstat (limited to 'check-blueprint-vs-input')
-rwxr-xr-xcheck-blueprint-vs-input/bin/check-blueprint-vs-input215
-rw-r--r--check-blueprint-vs-input/man/check-blueprint-vs-input.150
-rw-r--r--check-blueprint-vs-input/man/check-blueprint-vs-input.man55
-rw-r--r--check-blueprint-vs-input/pom.xml250
4 files changed, 0 insertions, 570 deletions
diff --git a/check-blueprint-vs-input/bin/check-blueprint-vs-input b/check-blueprint-vs-input/bin/check-blueprint-vs-input
deleted file mode 100755
index 9174526..0000000
--- a/check-blueprint-vs-input/bin/check-blueprint-vs-input
+++ /dev/null
@@ -1,215 +0,0 @@
-#!/usr/bin/env python3
-# -*- indent-tabs-mode: nil -*-
-# 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 code 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.
-
-from __future__ import print_function
-
-"""
-
- NAME
- check-blueprint-vs-input - given a blueprint and inputs file pair, validate them against each other
-
- USAGE
- check-blueprint-vs-input [-v] [-t] -b BLUEPRINT [-B exclusion-list] -i INPUTS [-B exclusion-list]
-
- DESCRIPTION
-"""
-description = """
- Validate a blueprint and inputs file against each other. This looks for the inputs: node of the blueprint
- file, the inputs used by {get_input} within the blueprint, and the values found in the inputs file. The
- files may be in either YAML or JSON formats. The names default to blueprint.yaml and inputs.yaml. If
- a blueprint inputs name has a default value, it is not considered an error if it is not in the inputs file.
-
- If using a template inputs file, add the -t/--template option. This will look for the inputs under
- an "inputs:" node instead of at the top level.
-
- If there are blueprint nodes or inputs nodes that should not be considered an error, specify them
- using the -B/--blueprint-exclusion-list and -I/inputs-exclusion-list parameters.
-
- "check-blueprint-vs-input --help" will list all of the available options.
-"""
-epilog = """
- NOTE
- Values specified within the inputs file with no value or a value of {} (such as 'openstack: {}')
- do not get loaded from the yaml dictionary, and will show up as false positives. It is suggested that
- -B/--blueprint-exclusion-list be used for these, and then do a subsequent grep for those variables
- being in the inputs file, as in:
-
- grep 'openstack: {}' $(BLUEPRINT)
-
-"""
-
-import yaml
-import sys
-import argparse
-
-def main():
- DEF_BLUEPRINT_NAME = "blueprint.yaml"
- DEF_INPUTS_NAME = "inputs.yaml"
- parser = argparse.ArgumentParser(description=description, epilog=epilog)
- parser.add_argument("-b", "--blueprint", type=str, help="Path to blueprint file, defaults to '%s'" % DEF_BLUEPRINT_NAME,
- default=DEF_BLUEPRINT_NAME)
- parser.add_argument("-i", "--inputs", type=str, help="Port to listen on, defaults to '%s'" % DEF_INPUTS_NAME,
- default=DEF_INPUTS_NAME)
- parser.add_argument("-B", "--blueprint-exclusion-list", type=str, help="Comma-separated list of names not to warn about not being in the blueprint file", default="")
- parser.add_argument("-I", "--inputs-exclusion-list", type=str, help="Comma-separated list of names not to warn about not being in the inputs file", default="")
- parser.add_argument("-t", "--inputs-template", help="Treat inputs file as coming from template area", action="store_true")
- parser.add_argument("-v", "--verbose", help="Verbose, may be specified multiple times", action="count", default=0)
- args = parser.parse_args()
-
- blueprintExclusionList = args.blueprint_exclusion_list.split(",")
- if args.verbose: print("blueprintExclusionList=%s" % blueprintExclusionList)
-
- inputsExclusionList = args.inputs_exclusion_list.split(",")
- if args.verbose: print("inputsExclusionList=%s" % inputsExclusionList)
-
- def loadYaml(filename):
- """
- Load a YAML file
- """
- with open(filename, "r") as fd:
- try:
- y = yaml.safe_load(fd)
- if args.verbose > 1:
- print("Contents of %s:" % filename)
- yaml.dump(y, sys.stdout)
- except:
- type, value, traceback = sys.exc_info()
- print('value=%s' % value, file=sys.stderr)
- return y
-
- blueprint = loadYaml(args.blueprint)
- inputs = loadYaml(args.inputs)
-
- # if inputs file is empty, provide an empty dictionary
- if inputs is None: inputs = { }
-
- # blueprint file has inputs under the inputs: node
- blueprintInputs = blueprint['inputs']
-
- # inputs file normally has inputs at the top level,
- # but templated inputs files have themunder the inputs: node
- if args.inputs_template: inputs = inputs['inputs']
-
-
- exitval = 0
-
- def check_blueprint_inputs(blueprintInputs, inputs, inputsExclusionList):
- """
- check the blueprint inputs against the inputs file
- """
- foundone = False
- for input in blueprintInputs:
- if args.verbose: print("blueprint input=%s" % input)
- if input in inputs:
- if args.verbose: print("\tIS in inputs file")
- else:
- # print("blueprintInputs.get(input)=%s and blueprintInputs[input].get('default')=%s" % (blueprintInputs.get(input), blueprintInputs[input].get('default')))
- if blueprintInputs.get(input) and blueprintInputs[input].get('default'):
- if args.verbose: print("\tHAS a default value")
- elif input not in inputsExclusionList:
- print("<<<<<<<<<<<<<<<< %s not in inputs file" % input)
- foundone = True
- else:
- if args.verbose: print("<<<<<<<<<<<<<<<< %s not in inputs file, but being ignored" % input)
- return foundone
-
- # check the blueprint inputs: against the inputs file
- if args.verbose: print("================ check the blueprint inputs: against the inputs file")
- foundone = check_blueprint_inputs(blueprintInputs, inputs, inputsExclusionList)
- if foundone: print("")
- if foundone: exitval = 1
-
- def check_get_inputs(blueprint, blueprintInputs, inputs, inputsExclusionList):
- """
- check the blueprint get_input values against the inputs file
- """
- if args.verbose > 2: print("check_get_inputs(): d=%s" % d)
-
- def findInputs(d):
- ret = [ ]
- if isinstance(d, dict):
- if args.verbose: print("type(d) is dict")
- for key in d.keys():
- if args.verbose: print("looking at d[key=%s]" % key)
- if key == "get_input":
- if args.verbose: print("found get_input, adding '%s'" % d[key])
- ret += [ d[key] ]
- return ret
- else:
- if args.verbose: print("going recursive on '%s'" % d[key])
- ret += findInputs(d[key])
- elif isinstance(d, list):
- if args.verbose: print("type(d) is list")
- for val in d:
- if args.verbose: print("going recursive on '%s'" % val)
- ret += findInputs(val)
- else:
- if args.verbose: print("type(d) is scalar: %s" % d)
- return ret
-
- foundone = False
- inputList = findInputs(blueprint)
- if args.verbose: print("done looking for get_input, found:\n%s" % inputList)
- alreadySeen = { }
- for input in inputList:
- if input not in alreadySeen:
- alreadySeen[input] = True
- if args.verbose: print("checking input %s" % input)
- if input in inputs:
- if args.verbose: print("\tIS in input file")
- else:
- if blueprintInputs.get(input) and blueprintInputs[input].get('default'):
- if args.verbose: print("\tHAS a default value")
- elif input not in inputsExclusionList:
- print(":::::::::::::::: get_input: %s is NOT in input file" % input)
- foundone = True
- else:
- if args.verbose: print(":::::::::::::::: get_input: %s is NOT in input file, but being ignored" % input)
-
- return foundone
-
-
-
- # check the blueprint's get_input calls against the inputs file
- if args.verbose: print("================ check the blueprint's get_input calls against the inputs file ================")
- foundone = check_get_inputs(blueprint, blueprintInputs, inputs, inputsExclusionList)
- if foundone: print("")
- if foundone: exitval = 1
-
- def check_inputs(blueprintInputs, inputs, blueprintExclusionList):
- """
- check the inputs file against the blueprints inputs list
- """
- foundone = False
- for key in inputs:
- if args.verbose: print("inputs key=%s" % key)
- if key in blueprintInputs:
- if args.verbose: print("\tIS in blueprint")
- else:
- if key not in blueprintExclusionList:
- print(">>>>>>>>>>>>>>>> %s not in blueprint file" % key)
- foundone = True
- else:
- if args.verbose: print(">>>>>>>>>>>>>>>> %s not in blueprint file, but being ignored" % key)
- return foundone
-
- # check the inputs file against the blueprints input: section
- if args.verbose: print("================ check the inputs file against the blueprints input: section ================")
- foundone = check_inputs(blueprintInputs, inputs, blueprintExclusionList)
- if foundone: exitval = 1
- sys.exit(exitval)
-
-if __name__ == "__main__":
- main()
diff --git a/check-blueprint-vs-input/man/check-blueprint-vs-input.1 b/check-blueprint-vs-input/man/check-blueprint-vs-input.1
deleted file mode 100644
index 247fbc6..0000000
--- a/check-blueprint-vs-input/man/check-blueprint-vs-input.1
+++ /dev/null
@@ -1,50 +0,0 @@
-check-blueprint-vs-input(1UTIL) ONAP check-blueprint-vs-input(1UTIL)
-
-
-
-NNAAMMEE
- check-blueprint-vs-input
-
-SSYYNNOOPPSSIISS
- check-blueprint-vs-input [-h] [-b BLUEPRINT] [-i INPUTS]
- [-B BLUEPRINT_EXCLUSION_LIST]
- [-I INPUTS_EXCLUSION_LIST] [-t] [-v]
-
-DDEESSCCRRIIPPTTIIOONN
- Validate a blueprint and inputs file against each other. This looks for
- the inputs: node of the blueprint file, the inputs used by {get_input}
- within the blueprint, and the values found in the inputs file. The
- files may be in either YAML or JSON formats. The names default to blue‐
- print.yaml and inputs.yaml. If a blueprint inputs name has a default
- value, it is not considered an error if it is not in the inputs file.
- If using a template inputs file, add the -t/--template option. This
- will look for the inputs under an "inputs:" node instead of at the top
- level. If there are blueprint nodes or inputs nodes that should not be
- considered an error, specify them using the -B/--blueprint- exclusion-
- list and -I/inputs-exclusion-list parameters. "check-blueprint-vs-
- input --help" will list all of the available options.
-
- OOPPTTIIOONNSS
- -h, --help show this help message and exit
-
- -b BLUEPRINT, --blueprint BLUEPRINT Path to blueprint file, defaults to
- 'blueprint.yaml'
-
- -i INPUTS, --inputs INPUTS Port to listen on, defaults to 'inputs.yaml'
-
- -B BLUEPRINT_EXCLUSION_LIST, --blueprint-exclusion-list BLUE‐
- PRINT_EXCLUSION_LIST Comma-separated list of names
- not to warn about not
- being in the blueprint file
-
- -I INPUTS_EXCLUSION_LIST, --inputs-exclusion-list INPUTS_EXCLUSION_LIST
- Comma-separated list of names not to warn about not
- being in the inputs file
-
- -t, --inputs-template Treat inputs file as coming from template area
-
- -v, --verbose Verbose, may be specified multiple times
-
-
-
-ONAP {{DATE}} check-blueprint-vs-input(1UTIL)
diff --git a/check-blueprint-vs-input/man/check-blueprint-vs-input.man b/check-blueprint-vs-input/man/check-blueprint-vs-input.man
deleted file mode 100644
index 017d529..0000000
--- a/check-blueprint-vs-input/man/check-blueprint-vs-input.man
+++ /dev/null
@@ -1,55 +0,0 @@
-'\" 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 code 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.
-.TH check-blueprint-vs-input 1UTIL {{DATE}} ONAP ONAP
-.SH NAME
-check-blueprint-vs-input
-.SH SYNOPSIS
-check-blueprint-vs-input [-h] [-b BLUEPRINT] [-i INPUTS]
- [-B BLUEPRINT_EXCLUSION_LIST]
- [-I INPUTS_EXCLUSION_LIST] [-t] [-v]
-.SH DESCRIPTION
-Validate a blueprint and inputs file against each other. This looks for the
-inputs: node of the blueprint file, the inputs used by {get_input} within the
-blueprint, and the values found in the inputs file. The files may be in either
-YAML or JSON formats. The names default to blueprint.yaml and inputs.yaml. If
-a blueprint inputs name has a default value, it is not considered an error if
-it is not in the inputs file. If using a template inputs file, add the
--t/--template option. This will look for the inputs under an "inputs:" node
-instead of at the top level. If there are blueprint nodes or inputs nodes that
-should not be considered an error, specify them using the -B/--blueprint-
-exclusion-list and -I/inputs-exclusion-list parameters. "check-blueprint-vs-
-input --help" will list all of the available options.
-.SS OPTIONS
-.HP 20
--h, --help
-show this help message and exit
-.HP 20
--b BLUEPRINT, --blueprint BLUEPRINT
-Path to blueprint file, defaults to 'blueprint.yaml'
-.HP 20
--i INPUTS, --inputs INPUTS
-Port to listen on, defaults to 'inputs.yaml'
-.HP 20
--B BLUEPRINT_EXCLUSION_LIST, --blueprint-exclusion-list BLUEPRINT_EXCLUSION_LIST
-Comma-separated list of names not to warn about not
- being in the blueprint file
-.HP 20
--I INPUTS_EXCLUSION_LIST, --inputs-exclusion-list INPUTS_EXCLUSION_LIST
-Comma-separated list of names not to warn about not
- being in the inputs file
-.HP 20
--t, --inputs-template
-Treat inputs file as coming from template area
-.HP 20
--v, --verbose
-Verbose, may be specified multiple times
diff --git a/check-blueprint-vs-input/pom.xml b/check-blueprint-vs-input/pom.xml
deleted file mode 100644
index 2bf822f..0000000
--- a/check-blueprint-vs-input/pom.xml
+++ /dev/null
@@ -1,250 +0,0 @@
-<?xml version="1.0"?>
-<!--
-================================================================================
-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=========================================================
-
-ECOMP is a trademark and service mark of AT&T Intellectual Property.
--->
-<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">
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.onap.dcaegen2.utils</groupId>
- <artifactId>utils</artifactId>
- <version>1.0.0-SNAPSHOT</version>
- </parent>
- <groupId>org.onap.dcaegen2.utils</groupId>
- <artifactId>check-blueprint-vs-input</artifactId>
- <name>dcaegen2-utils-check-blueprint-vs-input</name>
- <version>1.0.0-SNAPSHOT</version>
- <url>http://maven.apache.org</url>
-
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <sonar.skip>true</sonar.skip>
- <sonar.sources>.</sonar.sources>
- <!-- customize the SONARQUBE URL -->
- <!-- sonar.host.url>http://localhost:9000</sonar.host.url -->
- <!-- below are language dependent -->
- <!-- for Python -->
- <sonar.language>py</sonar.language>
- <sonar.pluginName>Python</sonar.pluginName>
- <sonar.inclusions>**/*.py</sonar.inclusions>
- <!-- for JavaScaript -->
- <!--
- <sonar.language>js</sonar.language>
- <sonar.pluginName>JS</sonar.pluginName>
- <sonar.inclusions>**/*.js</sonar.inclusions>
- -->
- </properties>
- <build>
- <finalName>${project.artifactId}-${project.version}</finalName>
- <pluginManagement>
- <plugins>
- <!-- the following plugins are invoked from oparent, we do not need them -->
- <plugin>
- <groupId>org.sonatype.plugins</groupId>
- <artifactId>nexus-staging-maven-plugin</artifactId>
- <version>1.6.7</version>
- <configuration>
- <skipNexusStagingDeployMojo>true</skipNexusStagingDeployMojo>
- </configuration>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-deploy-plugin</artifactId>
- <!-- This version supports the "deployAtEnd" parameter -->
- <version>2.8</version>
- <configuration>
- <skip>true</skip>
- </configuration>
- </plugin>
- <!-- first disable the default Java plugins at various stages -->
- <!-- maven-resources-plugin is called during "*resource" phases by default behavior. it prepares
- the resources dir. we do not need it -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <version>2.6</version>
- <configuration>
- <skip>true</skip>
- </configuration>
- </plugin>
- <!-- maven-compiler-plugin is called during "compile" phases by default behavior. we do not need it -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-compiler-plugin</artifactId>
- <version>3.1</version>
- <configuration>
- <skip>true</skip>
- </configuration>
- </plugin>
- <!-- maven-jar-plugin is called during "compile" phase by default behavior. we do not need it -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jar-plugin</artifactId>
- <version>2.4</version>
- <executions>
- <execution>
- <id>default-jar</id>
- <phase/>
- </execution>
- </executions>
- </plugin>
- <!-- maven-install-plugin is called during "install" phase by default behavior. it tries to copy stuff under
- target dir to ~/.m2. we do not need it -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-install-plugin</artifactId>
- <version>2.4</version>
- <configuration>
- <skip>true</skip>
- </configuration>
- </plugin>
- <!-- maven-surefire-plugin is called during "test" phase by default behavior. it triggers junit test.
- we do not need it -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-plugin</artifactId>
- <version>2.12.4</version>
- <configuration>
- <skipTests>true</skipTests>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- <plugins>
- <!-- plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <version>2.4.1</version>
- <configuration>
- <descriptors>
- <descriptor>assembly/dep.xml</descriptor>
- </descriptors>
- </configuration>
- <executions>
- <execution>
- <id>make-assembly</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- </execution>
- </executions>
- </plugin -->
- <!-- now we configure custom action (calling a script) at various lifecycle phases -->
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>exec-maven-plugin</artifactId>
- <version>1.2.1</version>
- <executions>
- <execution>
- <id>clean phase script</id>
- <phase>clean</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <arguments>
- <argument>${project.artifactId}</argument>
- <argument>clean</argument>
- </arguments>
- </configuration>
- </execution>
- <execution>
- <id>generate-sources script</id>
- <phase>generate-sources</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <arguments>
- <argument>${project.artifactId}</argument>
- <argument>generate-sources</argument>
- </arguments>
- </configuration>
- </execution>
- <execution>
- <id>compile script</id>
- <phase>compile</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <arguments>
- <argument>${project.artifactId}</argument>
- <argument>compile</argument>
- </arguments>
- </configuration>
- </execution>
- <execution>
- <id>package script</id>
- <phase>package</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <arguments>
- <argument>${project.artifactId}</argument>
- <argument>package</argument>
- </arguments>
- </configuration>
- </execution>
- <execution>
- <id>test script</id>
- <phase>test</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <arguments>
- <argument>${project.artifactId}</argument>
- <argument>test</argument>
- </arguments>
- </configuration>
- </execution>
- <execution>
- <id>install script</id>
- <phase>install</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <arguments>
- <argument>${project.artifactId}</argument>
- <argument>install</argument>
- </arguments>
- </configuration>
- </execution>
- <execution>
- <id>deploy script</id>
- <phase>deploy</phase>
- <goals>
- <goal>exec</goal>
- </goals>
- <configuration>
- <arguments>
- <argument>${project.artifactId}</argument>
- <argument>deploy</argument>
- <argument>bin/check-blueprint-vs-input</argument>
- <argument>man/check-blueprint-vs-input.1</argument>
- </arguments>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
-</project>