From ac6ce12f3f165052a2535910d3e8b5ff7b513ee3 Mon Sep 17 00:00:00 2001 From: Scott Bailey Date: Tue, 11 Apr 2023 14:22:37 -0500 Subject: [PATCH 1/4] Add escape_transform. --- tools/add_to.hpp | 16 +++++++++------- tools/common.hpp | 12 ++++++++++-- tools/update.hpp | 16 +++++++++------- 3 files changed, 28 insertions(+), 16 deletions(-) diff --git a/tools/add_to.hpp b/tools/add_to.hpp index 82dd839f..2e7a28af 100644 --- a/tools/add_to.hpp +++ b/tools/add_to.hpp @@ -25,7 +25,7 @@ namespace antler { system::info_log("Valid names are of the form [a-zA-Z][_a-zA-Z0-9]+"); return false; } - + // TODO for the next release we will remove the C++ restrictions const auto& is_valid_cpp_lang = [](auto l) { return l == "cpp" || @@ -115,7 +115,7 @@ namespace antler { system::error_log("Dependency: {0} is invalid.", dep_name); return false; } - + obj.upsert_dependency(std::move(dep)); // We have values, so query the user if they want to apply. @@ -147,8 +147,10 @@ namespace antler { app_subcommand = subcommand->add_subcommand("app", "Add a new app to your project."); app_subcommand->add_option("-n, name", obj_name, "The name of the app to add.")->required(); app_subcommand->add_option("-l, lang", lang, "Language this app will use.")->required(); - app_subcommand->add_option("--comp, compile_options", copts, "Options for the compiler for this app."); - app_subcommand->add_option("--link, link_options", lopts, "Options for the linker for this app."); + app_subcommand->add_option("--comp, compile_options", copts, "Options for the compiler for this app.") + ->transform(escape_transform); + app_subcommand->add_option("--link, link_options", lopts, "Options for the linker for this app.") + ->transform(escape_transform); lib_subcommand = subcommand->add_subcommand("lib", "Add a new library to your project."); lib_subcommand->add_option("-n, name", obj_name, "The name of the library to add.")->required(); @@ -163,7 +165,7 @@ namespace antler { dep_subcommand->add_option("-t, tag", tag, "Tag associated with the dependency."); dep_subcommand->add_option("-r, release", release, "Release version of the depedency."); dep_subcommand->add_option("--digest, hash", hash, "Hash of the dependency."); - + /* TODO Add back after this release when we have the testing framework finished test_subcommand = subcommand->add_subcommand("test", "Add a new test to the project."); test_subcommand->add_option("-n, name", obj_name, "The name of the test to add.")->required(); @@ -198,7 +200,7 @@ namespace antler { proj.sync(); return 0; } - + CLI::App* subcommand; CLI::App* app_subcommand; CLI::App* dep_subcommand; @@ -216,4 +218,4 @@ namespace antler { std::string lopts; std::string cmd; }; -} // namespace antler \ No newline at end of file +} // namespace antler diff --git a/tools/common.hpp b/tools/common.hpp index b59679fb..b6ff14c3 100644 --- a/tools/common.hpp +++ b/tools/common.hpp @@ -7,13 +7,21 @@ namespace antler { + std::string escape_transform(std::string input) { + for(auto i=input.begin(); i != input.end(); ++i) { + if(*i == '\\' && i+1 != input.end()) + i = input.erase(i); + } + return input; + } + inline project::project load_project(const system::fs::path& path) { auto p = system::fs::canonical(system::fs::path(path)); ANTLER_CHECK(project::project::update_path(p), "path either did not exist or no `project.yml` file cound be found."); project::project proj; ANTLER_CHECK(proj.from_yaml(project::yaml::load(p)), - "error while loading project.yml file"); + "error while loading project.yml file"); proj.path(p.parent_path()); return proj; } @@ -32,4 +40,4 @@ namespace antler { return last_pop_time < last_manifest_time; } -} \ No newline at end of file +} diff --git a/tools/update.hpp b/tools/update.hpp index 9f2d9123..01340262 100644 --- a/tools/update.hpp +++ b/tools/update.hpp @@ -33,7 +33,7 @@ namespace antler { obj.compile_options(copts); if (!lopts_opt->empty()) obj.link_options(lopts); - + system::info_log("Updating object: {0}\n" "language: {1}\n" "compile options: {2}\n" @@ -42,7 +42,7 @@ namespace antler { obj.language(), copts, lopts); - + return true; } catch(...) { system::error_log("Object {0} does not exist in the project", obj_name); @@ -115,8 +115,10 @@ namespace antler { app_subcommand = subcommand->add_subcommand("app", "Remove app from the project."); app_subcommand->add_option("-n, name", obj_name, "The name of the app to remove.")->required(); app_subcommand->add_option("-l, language", lang, "The language of the app."); - app_subcommand->add_option("--comp, compile_options", copts, "The compile options used to build the app."); - app_subcommand->add_option("--link, link_options", lopts, "The link options used to build the app."); + app_subcommand->add_option("--comp, compile_options", copts, "The compile options used to build the app.") + ->transform(escape_transform); + app_subcommand->add_option("--link, link_options", lopts, "The link options used to build the app.") + ->transform(escape_transform); lib_subcommand = subcommand->add_subcommand("lib", "Remove lib from the project."); lib_subcommand->add_option("-n, name", obj_name, "The name of the library to add.")->required(); @@ -136,7 +138,7 @@ namespace antler { test_subcommand = subcommand->add_subcommand("test", "Remove a test from the project."); test_subcommand->add_option("-n, name", dep_name, "The name of the test to remove.")->required(); */ - + } int32_t exec() { @@ -167,7 +169,7 @@ namespace antler { proj.sync(); return 0; } - + CLI::App* subcommand = nullptr; CLI::App* app_subcommand = nullptr; CLI::App* dep_subcommand = nullptr; @@ -184,4 +186,4 @@ namespace antler { std::string release = ""; std::string digest = ""; }; -} // namespace antler \ No newline at end of file +} // namespace antler From 1d3fec48e77dba09432ad9cf82ca66b62a4f09f9 Mon Sep 17 00:00:00 2001 From: Scott Bailey Date: Tue, 11 Apr 2023 20:51:00 -0500 Subject: [PATCH 2/4] Adding tests to ensure link and compile flags like "-O2" are accepted. --- tools/CMakeLists.txt | 1 + tools/tests/add_and_update.py | 129 ++++++++++++++++++++++++++++++++++ tools/tests/util.py | 11 ++- 3 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 tools/tests/add_and_update.py diff --git a/tools/CMakeLists.txt b/tools/CMakeLists.txt index 78fe2732..219e7c8b 100644 --- a/tools/CMakeLists.txt +++ b/tools/CMakeLists.txt @@ -15,4 +15,5 @@ if (ANTLER_PROJ_BUILD_TESTS) # TODO renable when add to test code is completed: #add_cli_test(add_to_project_tests add_to_tests.py) add_cli_test(init_tests init_tests.py) + add_cli_test(add_and_update add_and_update.py) endif() diff --git a/tools/tests/add_and_update.py b/tools/tests/add_and_update.py new file mode 100644 index 00000000..47bad312 --- /dev/null +++ b/tools/tests/add_and_update.py @@ -0,0 +1,129 @@ +#! /usr/bin/env python3 + +import sys + +from util import * +from init_tests import init_project + +project_name="aou_project" +project_path=os.path.join("./",project_name) + +def expect_subvalue(ll, name, tag, value): + """Inside ll, find the list that contains `name` and test the value stored in that list for the given tag against value. + + :param ll An array of lists. + :param name The name to search for. + :tag The tag that contains the value we to test. + :value The expected value. + """ + + for i in ll: + if i["name"] == name: + return i[tag] == value + return False + + +def setup_project(): + """Setup the project ensuring there is a fresh project file. + """ + + shutil.rmtree(project_path, ignore_errors=True) + init_project(project_name, "v1.0.0", project_path) + assert(os.path.isdir(project_path)) + + +def test_app_compile_options(): + """Add an application to the project and test its compile options can be updated. + """ + + out, err = antler_in_proj_cmd(project_path, "add app App1 C++ \\\\-O1") + print(out) + project = load_project(project_path) + assert( expect_subvalue(project["apps"], "App1", "compile_options", "-O1") ) + + out, err = antler_in_proj_cmd(project_path, "update app App1 C++ \\\\-O2") + print(out) + project = load_project(project_path) + assert( expect_subvalue(project["apps"], "App1", "compile_options", "-O2") ) + + +def test_app_link_options(): + """Add an application to the project and test its compile and link options can be updated. + """ + + out, err = antler_in_proj_cmd(project_path, "add app App2 C++ \"\\-O1\" \\\\-t") + print(out) + project = load_project(project_path) + assert( expect_subvalue(project["apps"], "App2", "compile_options", "-O1") ) + assert( expect_subvalue(project["apps"], "App2", "link_options", "-t") ) + + out, err = antler_in_proj_cmd(project_path, "update app App2 C++ \"\\-O2\" \\\\-s") + print(out) + project = load_project(project_path) + assert( expect_subvalue(project["apps"], "App2", "compile_options", "-O2") ) + assert( expect_subvalue(project["apps"], "App2", "link_options", "-s") ) + + +def test_app_update_options(): + """Add an application to the project and test its compile and link options can be updated with flags. + """ + + out, err = antler_in_proj_cmd(project_path, "add app App3 C++") + print(out) + project = load_project(project_path) + assert( expect_subvalue(project["apps"], "App3", "compile_options", "") ) + assert( expect_subvalue(project["apps"], "App3", "link_options", "") ) + + out, err = antler_in_proj_cmd(project_path, "update app App3 --comp \\\\-O1") + print(out) + assert( expect_subvalue(load_project(project_path)["apps"], "App3", "compile_options", "-O1") ) + out, err = antler_in_proj_cmd(project_path, "update app App3 --comp \"\\-O2\"") + print(out) + assert( expect_subvalue(load_project(project_path)["apps"], "App3", "compile_options", "-O2") ) + + out, err = antler_in_proj_cmd(project_path, "update app App3 --link \\\\-s") + print(out) + assert( expect_subvalue(load_project(project_path)["apps"], "App3", "link_options", "-s") ) + out, err = antler_in_proj_cmd(project_path, "update app App3 --link \"\\-t\"") + print(out) + assert( expect_subvalue(load_project(project_path)["apps"], "App3", "link_options", "-t") ) + + assert( expect_subvalue(load_project(project_path)["apps"], "App3", "compile_options", "-O2") ) + + +def test_lib_options(): + """Add a library to the project and test its compile and link options can be updated with flags. + """ + + out, err = antler_in_proj_cmd(project_path, "add lib Lib1 C++") + print(out) + project = load_project(project_path) + assert( expect_subvalue(project["libs"], "Lib1", "compile_options", "") ) + assert( expect_subvalue(project["libs"], "Lib1", "link_options", "") ) + + out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --comp -O1") + print(out) + assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "compile_options", "-O1") ) + out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --comp \"-O2\"") + print(out) + assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "compile_options", "-O2") ) + + out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --link -s") + print(out) + assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "link_options", "-s") ) + out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --link \"-t\"") + print(out) + assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "link_options", "-t") ) + + assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "compile_options", "-O2") ) + + + + + +if __name__ == "__main__": + setup_project() + test_app_compile_options() + test_app_link_options() + test_app_update_options() + test_lib_options() diff --git a/tools/tests/util.py b/tools/tests/util.py index 9d72196b..40c46a99 100644 --- a/tools/tests/util.py +++ b/tools/tests/util.py @@ -5,13 +5,22 @@ import yaml import shutil +TEST_PATH = os.path.dirname(os.path.abspath(__file__)) +APROJ_EXE = TEST_PATH + "/../antler-proj" + def run_cmd(cmd): + """ Execute `cmd`. """ p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) out, err = p.communicate() return out.decode('utf-8'), err.decode('utf-8') def antler_proj_cmd(args): - return run_cmd("../antler-proj " + args) + """ Run antler-proj with `args`. """ + return run_cmd(APROJ_EXE + " " + args) + +def antler_in_proj_cmd(path, args): + """ Change directory to `path` and run antler-proj with `args`. """ + return run_cmd("cd " + path + "; " + APROJ_EXE + " " + args) def load_project(path): with open("./{0}/project.yml".format(path), "r") as f: From 52bce66fd018bc213b2ba4c9b86739b7d9835677 Mon Sep 17 00:00:00 2001 From: Scott Bailey Date: Thu, 13 Apr 2023 09:06:33 -0500 Subject: [PATCH 3/4] Add docs --- tools/common.hpp | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tools/common.hpp b/tools/common.hpp index b6ff14c3..97333ecf 100644 --- a/tools/common.hpp +++ b/tools/common.hpp @@ -7,8 +7,15 @@ namespace antler { + /// Remove escape sequence character from input. + /// @note This is a SIMPLE algorithm that ONLY removes the first `\` in a 2 charachter sequence. + /// @todo Consider implementing more complicated transforms (e.g. convert "\t" to 0x09 or "\xFF" to 0xFF, etc). + /// @param input Input string that may or may not contain escape characters. + /// @return The transformed string. std::string escape_transform(std::string input) { for(auto i=input.begin(); i != input.end(); ++i) { + // Only remove this char *if* there is a char following. + // Note: erase plus increment effectively steps over the char follwing the erased `\` (e.g. "\\-O2" becomes "\-O2"). if(*i == '\\' && i+1 != input.end()) i = input.erase(i); } From 877897098f18a86f2d33d3631bb014fe56d84d3c Mon Sep 17 00:00:00 2001 From: Scott Bailey Date: Thu, 13 Apr 2023 10:20:43 -0500 Subject: [PATCH 4/4] pylint changes. --- .pylintrc | 621 ++++++++++++++++++++++++++++++++++ tools/tests/add_and_update.py | 181 +++++----- tools/tests/init_tests.py | 1 + tools/tests/util.py | 22 +- 4 files changed, 729 insertions(+), 96 deletions(-) create mode 100644 .pylintrc diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 00000000..a44c6018 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,621 @@ +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\' represents the directory delimiter on Windows systems, it +# can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +#jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.8 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=snake_case + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + rv, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=BaseException, + Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +# 140 was chosen to work nicely on 14" laptops. +max-line-length=140 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + missing-module-docstring, + missing-class-docstring, + missing-function-docstring, + unused-variable, + unused-argument, + too-many-public-methods, + too-few-public-methods + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +#notes=FIXME, XXX, TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/tools/tests/add_and_update.py b/tools/tests/add_and_update.py index 47bad312..5bcc503d 100644 --- a/tools/tests/add_and_update.py +++ b/tools/tests/add_and_update.py @@ -1,129 +1,136 @@ #! /usr/bin/env python3 -import sys +""" Test `antler-proj add` and `antler proj update` commands. """ -from util import * +import os +import shutil + +from util import antler_in_proj_cmd, load_project from init_tests import init_project -project_name="aou_project" -project_path=os.path.join("./",project_name) +PROJECT_NAME="aou_project" +PROJECT_PATH=os.path.join("./",PROJECT_NAME) + +def expect_subvalue(array_of_lists, name, tag, value): + """ Inside array_of_lists, find the list that contains `name` and test the value + stored in that list for the given tag against value. + -def expect_subvalue(ll, name, tag, value): - """Inside ll, find the list that contains `name` and test the value stored in that list for the given tag against value. + :param array_of_lists An array of lists. + :param name The name to search for. + :tag The tag that contains the value we to test. + :value The expected value. - :param ll An array of lists. - :param name The name to search for. - :tag The tag that contains the value we to test. - :value The expected value. - """ + """ - for i in ll: - if i["name"] == name: - return i[tag] == value - return False + for i in array_of_lists: + if i["name"] == name: + return i[tag] == value + return False def setup_project(): - """Setup the project ensuring there is a fresh project file. - """ + """Setup the project ensuring there is a fresh project file. + """ - shutil.rmtree(project_path, ignore_errors=True) - init_project(project_name, "v1.0.0", project_path) - assert(os.path.isdir(project_path)) + shutil.rmtree(PROJECT_PATH, ignore_errors=True) + init_project(PROJECT_NAME, "v1.0.0", PROJECT_PATH) + assert os.path.isdir(PROJECT_PATH) def test_app_compile_options(): - """Add an application to the project and test its compile options can be updated. - """ + """Add an application to the project and test its compile options can be updated. + """ - out, err = antler_in_proj_cmd(project_path, "add app App1 C++ \\\\-O1") - print(out) - project = load_project(project_path) - assert( expect_subvalue(project["apps"], "App1", "compile_options", "-O1") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "add app App1 C++ \\\\-O1") + print(out) + project = load_project(PROJECT_PATH) + assert expect_subvalue(project["apps"], "App1", "compile_options", "-O1") - out, err = antler_in_proj_cmd(project_path, "update app App1 C++ \\\\-O2") - print(out) - project = load_project(project_path) - assert( expect_subvalue(project["apps"], "App1", "compile_options", "-O2") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update app App1 C++ \\\\-O2") + print(out) + project = load_project(PROJECT_PATH) + assert expect_subvalue(project["apps"], "App1", "compile_options", "-O2") def test_app_link_options(): - """Add an application to the project and test its compile and link options can be updated. - """ + """Add an application to the project and test its compile and link options can be updated. + """ - out, err = antler_in_proj_cmd(project_path, "add app App2 C++ \"\\-O1\" \\\\-t") - print(out) - project = load_project(project_path) - assert( expect_subvalue(project["apps"], "App2", "compile_options", "-O1") ) - assert( expect_subvalue(project["apps"], "App2", "link_options", "-t") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "add app App2 C++ \"\\-O1\" \\\\-t") + print(out) + project = load_project(PROJECT_PATH) + assert expect_subvalue(project["apps"], "App2", "compile_options", "-O1") + assert expect_subvalue(project["apps"], "App2", "link_options", "-t") - out, err = antler_in_proj_cmd(project_path, "update app App2 C++ \"\\-O2\" \\\\-s") - print(out) - project = load_project(project_path) - assert( expect_subvalue(project["apps"], "App2", "compile_options", "-O2") ) - assert( expect_subvalue(project["apps"], "App2", "link_options", "-s") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update app App2 C++ \"\\-O2\" \\\\-s") + print(out) + project = load_project(PROJECT_PATH) + assert expect_subvalue(project["apps"], "App2", "compile_options", "-O2") + assert expect_subvalue(project["apps"], "App2", "link_options", "-s") def test_app_update_options(): - """Add an application to the project and test its compile and link options can be updated with flags. - """ + """Add an application to the project and test its compile and link options + can be updated with flags. + """ - out, err = antler_in_proj_cmd(project_path, "add app App3 C++") - print(out) - project = load_project(project_path) - assert( expect_subvalue(project["apps"], "App3", "compile_options", "") ) - assert( expect_subvalue(project["apps"], "App3", "link_options", "") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "add app App3 C++") + print(out) + project = load_project(PROJECT_PATH) + assert expect_subvalue(project["apps"], "App3", "compile_options", "") + assert expect_subvalue(project["apps"], "App3", "link_options", "") - out, err = antler_in_proj_cmd(project_path, "update app App3 --comp \\\\-O1") - print(out) - assert( expect_subvalue(load_project(project_path)["apps"], "App3", "compile_options", "-O1") ) - out, err = antler_in_proj_cmd(project_path, "update app App3 --comp \"\\-O2\"") - print(out) - assert( expect_subvalue(load_project(project_path)["apps"], "App3", "compile_options", "-O2") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update app App3 --comp \\\\-O1") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["apps"], "App3", "compile_options", "-O1") + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update app App3 --comp \"\\-O2\"") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["apps"], "App3", "compile_options", "-O2") - out, err = antler_in_proj_cmd(project_path, "update app App3 --link \\\\-s") - print(out) - assert( expect_subvalue(load_project(project_path)["apps"], "App3", "link_options", "-s") ) - out, err = antler_in_proj_cmd(project_path, "update app App3 --link \"\\-t\"") - print(out) - assert( expect_subvalue(load_project(project_path)["apps"], "App3", "link_options", "-t") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update app App3 --link \\\\-s") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["apps"], "App3", "link_options", "-s") + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update app App3 --link \"\\-t\"") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["apps"], "App3", "link_options", "-t") - assert( expect_subvalue(load_project(project_path)["apps"], "App3", "compile_options", "-O2") ) + assert expect_subvalue(load_project(PROJECT_PATH)["apps"], "App3", "compile_options", "-O2") def test_lib_options(): - """Add a library to the project and test its compile and link options can be updated with flags. - """ + """Add a library to the project and test its compile and link options can be updated with flags. + """ - out, err = antler_in_proj_cmd(project_path, "add lib Lib1 C++") - print(out) - project = load_project(project_path) - assert( expect_subvalue(project["libs"], "Lib1", "compile_options", "") ) - assert( expect_subvalue(project["libs"], "Lib1", "link_options", "") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "add lib Lib1 C++") + print(out) + project = load_project(PROJECT_PATH) + assert expect_subvalue(project["libs"], "Lib1", "compile_options", "") + assert expect_subvalue(project["libs"], "Lib1", "link_options", "") - out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --comp -O1") - print(out) - assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "compile_options", "-O1") ) - out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --comp \"-O2\"") - print(out) - assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "compile_options", "-O2") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update lib Lib1 --comp -O1") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["libs"], "Lib1", "compile_options", "-O1") + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update lib Lib1 --comp \"-O2\"") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["libs"], "Lib1", "compile_options", "-O2") - out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --link -s") - print(out) - assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "link_options", "-s") ) - out, err = antler_in_proj_cmd(project_path, "update lib Lib1 --link \"-t\"") - print(out) - assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "link_options", "-t") ) + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update lib Lib1 --link -s") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["libs"], "Lib1", "link_options", "-s") + out, _ = antler_in_proj_cmd(PROJECT_PATH, "update lib Lib1 --link \"-t\"") + print(out) + assert expect_subvalue(load_project(PROJECT_PATH)["libs"], "Lib1", "link_options", "-t") - assert( expect_subvalue(load_project(project_path)["libs"], "Lib1", "compile_options", "-O2") ) + assert expect_subvalue(load_project(PROJECT_PATH)["libs"], "Lib1", "compile_options", "-O2") if __name__ == "__main__": - setup_project() - test_app_compile_options() - test_app_link_options() - test_app_update_options() - test_lib_options() + setup_project() + test_app_compile_options() + test_app_link_options() + test_app_update_options() + test_lib_options() diff --git a/tools/tests/init_tests.py b/tools/tests/init_tests.py index ce340392..0cdc34e4 100644 --- a/tools/tests/init_tests.py +++ b/tools/tests/init_tests.py @@ -1,6 +1,7 @@ #! /usr/bin/env python3 import sys +import shutil from util import * diff --git a/tools/tests/util.py b/tools/tests/util.py index 40c46a99..2a4d9cbb 100644 --- a/tools/tests/util.py +++ b/tools/tests/util.py @@ -1,17 +1,18 @@ #! /usr/bin/env python3 +"""Utility functions for antler-proj testing.""" + import subprocess import os import yaml -import shutil TEST_PATH = os.path.dirname(os.path.abspath(__file__)) APROJ_EXE = TEST_PATH + "/../antler-proj" def run_cmd(cmd): """ Execute `cmd`. """ - p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) - out, err = p.communicate() + result = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) + out, err = result.communicate() return out.decode('utf-8'), err.decode('utf-8') def antler_proj_cmd(args): @@ -23,18 +24,21 @@ def antler_in_proj_cmd(path, args): return run_cmd("cd " + path + "; " + APROJ_EXE + " " + args) def load_project(path): - with open("./{0}/project.yml".format(path), "r") as f: - project = yaml.safe_load(f) + """ Load a project.yml file """ + with open("./{0}/project.yml".format(path), "r") as file_handle: + project = yaml.safe_load(file_handle) return project def expected_cmd(cmd, expected): - out, err = run_cmd(cmd) + """ Test that cmd has an expected result. """ + out, _ = run_cmd(cmd) if out != expected: print("ERROR: cmd: %s != expected: %s" % (cmd, expected)) - assert(False) + assert False def expected_proj_cmd(cmd, expected): - out, err = antler_proj_cmd(cmd) + """ Test that `antler-proj cmd` has an expected result. """ + out, _ = antler_proj_cmd(cmd) if out != expected: print("ERROR: cmd: %s != expected: %s" % (cmd, expected)) - assert(False) + assert False