fixed #12753 - do not look for extension-less library files / added more tests [skip ci]

Author: firewave

lib/library.cpp

@@ -196,24 +196,20 @@ Library::Error Library::load(const char exename[], const char path[], bool debug
 
     const bool is_abs_path = Path::isAbsolute(path);
 
+    std::string fullfilename(path);
+
+    // TODO: what if the extension is not .cfg?
+    // only append extension when we provide the library name and not a path - TODO: handle relative paths?
+    if (!is_abs_path && Path::getFilenameExtension(fullfilename).empty())
+        fullfilename += ".cfg";
+
     std::string absolute_path;
     // open file..
     tinyxml2::XMLDocument doc;
     if (debug)
-        std::cout << "looking for library '" + std::string(path) + "'" << std::endl;
-    tinyxml2::XMLError error = xml_LoadFile(doc, path);
+        std::cout << "looking for library '" + fullfilename + "'" << std::endl;
+    tinyxml2::XMLError error = xml_LoadFile(doc, fullfilename.c_str());
     if (error == tinyxml2::XML_ERROR_FILE_NOT_FOUND) {
-        // failed to open file.. is there no extension?
-        std::string fullfilename(path);
-        if (Path::getFilenameExtension(fullfilename).empty()) {
-            fullfilename += ".cfg";
-            if (debug)
-                std::cout << "looking for library '" + fullfilename + "'" << std::endl;
-            error = xml_LoadFile(doc, fullfilename.c_str());
-            if (error != tinyxml2::XML_ERROR_FILE_NOT_FOUND)
-                absolute_path = Path::getAbsoluteFilePath(fullfilename);
-        }
-
         // only perform further lookups when the given path was not absolute
         if (!is_abs_path && error == tinyxml2::XML_ERROR_FILE_NOT_FOUND)
         {

test/cli/lookup_test.py

@@ -11,7 +11,6 @@ def __remove_std_lookup_log(l : list, exepath):
     return l
 
 
-# TODO: test with FILESDIR
 def test_lib_lookup(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -24,15 +23,32 @@ def test_lib_lookup(tmpdir):
     assert exitcode == 0, stdout if stdout else stderr
     lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
     assert lines == [
-        "looking for library 'gnu'",
         "looking for library 'gnu.cfg'",
         "looking for library '{}/gnu.cfg'".format(exepath),
         "looking for library '{}/cfg/gnu.cfg'".format(exepath),
         'Checking {} ...'.format(test_file)
     ]
 
 
-# TODO: test with FILESDIR
+def test_lib_lookup_ext(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=library', '--library=gnu.cfg', test_file])
+    exepath = os.path.dirname(exe)
+    if sys.platform == 'win32':
+        exepath = exepath.replace('\\', '/')
+    assert exitcode == 0, stdout if stdout else stderr
+    lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
+    assert lines == [
+        "looking for library 'gnu.cfg'",
+        "looking for library '{}/gnu.cfg'".format(exepath),
+        "looking for library '{}/cfg/gnu.cfg'".format(exepath),
+        'Checking {} ...'.format(test_file)
+    ]
+
+
 def test_lib_lookup_notfound(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -46,7 +62,6 @@ def test_lib_lookup_notfound(tmpdir):
     lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
     assert lines == [
         # TODO: specify which folder is actually used for lookup here
-        "looking for library 'none'",  # TODO: this could conflict with the platform lookup
         "looking for library 'none.cfg'",
         # TODO: lookup of '{exepath}/none' missing - could conflict with the platform lookup though
         "looking for library '{}/none.cfg'".format(exepath),
@@ -57,6 +72,66 @@ def test_lib_lookup_notfound(tmpdir):
     ]
 
 
+def test_lib_lookup_ext_notfound(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=library', '--library=none.cfg', test_file])
+    exepath = os.path.dirname(exe)
+    if sys.platform == 'win32':
+        exepath = exepath.replace('\\', '/')
+    assert exitcode == 1, stdout if stdout else stderr
+    lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
+    assert lines == [
+        "looking for library 'none.cfg'",
+        "looking for library '{}/none.cfg'".format(exepath),
+        "looking for library '{}/cfg/none.cfg'".format(exepath),
+        "library not found: 'none.cfg'",
+        "cppcheck: Failed to load library configuration file 'none.cfg'. File not found"
+    ]
+
+
+def test_lib_lookup_relative_notfound(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=library', '--library=config/gnu.xml', test_file])
+    exepath = os.path.dirname(exe)
+    if sys.platform == 'win32':
+        exepath = exepath.replace('\\', '/')
+    assert exitcode == 1, stdout if stdout else stderr
+    lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
+    assert lines == [
+        "looking for library 'config/gnu.xml'",
+        "looking for library '{}/config/gnu.xml'".format(exepath),
+        "looking for library '{}/cfg/config/gnu.xml'".format(exepath),
+        "library not found: 'config/gnu.xml'",
+        "cppcheck: Failed to load library configuration file 'config/gnu.xml'. File not found"
+    ]
+
+
+def test_lib_lookup_relative_noext_notfound(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=library', '--library=config/gnu', test_file])
+    exepath = os.path.dirname(exe)
+    if sys.platform == 'win32':
+        exepath = exepath.replace('\\', '/')
+    assert exitcode == 1, stdout if stdout else stderr
+    lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
+    assert lines == [
+        "looking for library 'config/gnu.cfg'",
+        "looking for library '{}/config/gnu.cfg'".format(exepath),
+        "looking for library '{}/cfg/config/gnu.cfg'".format(exepath),
+        "library not found: 'config/gnu'",
+        "cppcheck: Failed to load library configuration file 'config/gnu'. File not found"
+    ]
+
+
 def test_lib_lookup_absolute(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -120,7 +195,6 @@ def test_lib_lookup_nofile(tmpdir):
     assert exitcode == 0, stdout if stdout else stderr
     lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
     assert lines == [
-        "looking for library 'gtk'",
         "looking for library 'gtk.cfg'",
         "looking for library '{}/gtk.cfg'".format(exepath),
         "looking for library '{}/cfg/gtk.cfg'".format(exepath),
@@ -140,11 +214,9 @@ def test_lib_lookup_multi(tmpdir):
     assert exitcode == 0, stdout if stdout else stderr
     lines = __remove_std_lookup_log(stdout.splitlines(), exepath)
     assert lines == [
-        "looking for library 'posix'",
         "looking for library 'posix.cfg'",
         "looking for library '{}/posix.cfg'".format(exepath),
         "looking for library '{}/cfg/posix.cfg'".format(exepath),
-        "looking for library 'gnu'",
         "looking for library 'gnu.cfg'",
         "looking for library '{}/gnu.cfg'".format(exepath),
         "looking for library '{}/cfg/gnu.cfg'".format(exepath),
@@ -167,7 +239,6 @@ def test_platform_lookup_builtin(tmpdir):
 
 
 # TODO: behaves differently when using a CMake build
-# TODO: test with FILESDIR
 @pytest.mark.skip
 def test_platform_lookup_external(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
@@ -190,7 +261,6 @@ def test_platform_lookup_external(tmpdir):
     ]
 
 
-# TODO: test with FILESDIR
 def test_platform_lookup_external_notfound(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -218,7 +288,6 @@ def test_platform_lookup_external_notfound(tmpdir):
     ]
 
 
-# TODO: test with FILESDIR
 def test_addon_lookup(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -237,7 +306,6 @@ def test_addon_lookup(tmpdir):
     ]
 
 
-# TODO: test with FILESDIR
 def test_addon_lookup_ext(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -256,7 +324,6 @@ def test_addon_lookup_ext(tmpdir):
     ]
 
 
-# TODO: test with FILESDIR
 def test_addon_lookup_notfound(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -275,7 +342,6 @@ def test_addon_lookup_notfound(tmpdir):
     ]
 
 
-# TODO: test with FILESDIR
 def test_addon_lookup_ext_notfound(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -294,7 +360,106 @@ def test_addon_lookup_ext_notfound(tmpdir):
     ]
 
 
-# TODO: test with FILESDIR
+def test_addon_lookup_relative_notfound(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    exitcode, stdout, _, exe = cppcheck_ex(['--debug-lookup=addon', '--addon=addon/misra.py', test_file])
+    exepath = os.path.dirname(exe)
+    exepath_sep = exepath + os.path.sep
+    assert exitcode == 1, stdout
+    lines = stdout.splitlines()
+    assert lines == [
+        "looking for addon 'addon/misra.py'",
+        "looking for addon '{}addon/misra.py'".format(exepath_sep),
+        "looking for addon '{}addons/addon/misra.py'".format(exepath_sep),  # TODO: mixed separators
+        'Did not find addon addon/misra.py'
+    ]
+
+
+def test_addon_lookup_relative_noext_notfound(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    exitcode, stdout, _, exe = cppcheck_ex(['--debug-lookup=addon', '--addon=addon/misra', test_file])
+    exepath = os.path.dirname(exe)
+    exepath_sep = exepath + os.path.sep
+    assert exitcode == 1, stdout
+    lines = stdout.splitlines()
+    assert lines == [
+        "looking for addon 'addon/misra.py'",
+        "looking for addon '{}addon/misra.py'".format(exepath_sep),
+        "looking for addon '{}addons/addon/misra.py'".format(exepath_sep),  # TODO: mixed separators
+        'Did not find addon addon/misra.py'
+    ]
+
+
+def test_addon_lookup_absolute(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    addon_file = os.path.join(tmpdir, 'test.py')
+    with open(addon_file, 'wt') as f:
+        f.write('''''')
+
+    exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=addon', '--addon={}'.format(addon_file), test_file])
+    exepath = os.path.dirname(exe)
+    exepath_sep = exepath + os.path.sep
+    assert exitcode == 0, stdout if stdout else stderr
+    lines = stdout.splitlines()
+    assert lines == [
+        "looking for addon '{}'".format(addon_file),
+        'Checking {} ...'.format(test_file)
+    ]
+
+
+def test_addon_lookup_absolute_notfound(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    addon_file = os.path.join(tmpdir, 'test.py')
+
+    exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=addon', '--addon={}'.format(addon_file), test_file])
+    exepath = os.path.dirname(exe)
+    exepath_sep = exepath + os.path.sep
+    assert exitcode == 1, stdout if stdout else stderr
+    lines = stdout.splitlines()
+    assert lines == [
+        "looking for addon '{}'".format(addon_file),
+        "looking for addon '{}{}'".format(exepath_sep, addon_file),  # TODO: should not perform this lookup
+        "looking for addon '{}addons/{}'".format(exepath_sep, addon_file),  # TODO: should not perform this lookup
+        'Did not find addon {}'.format(addon_file)
+    ]
+
+
+def test_addon_lookup_nofile(tmpdir):
+    test_file = os.path.join(tmpdir, 'test.c')
+    with open(test_file, 'wt'):
+        pass
+
+    # make sure we do not produce an error when the attempted lookup path is a directory and not a file
+    misra_dir = os.path.join(tmpdir, 'misra')
+    os.mkdir(misra_dir)
+    misra_cfg_dir = os.path.join(tmpdir, 'misra.py')
+    os.mkdir(misra_cfg_dir)
+
+    exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=addon', '--addon=misra', test_file])
+    exepath = os.path.dirname(exe)
+    exepath_sep = exepath + os.path.sep
+    assert exitcode == 0, stdout if stdout else stderr  # TODO. should fail when addon is not found
+    lines = stdout.splitlines()
+    assert lines == [
+        "looking for addon 'misra.py'",
+        "looking for addon '{}misra.py'".format(exepath_sep),
+        "looking for addon '{}addons/misra.py'".format(exepath_sep),  # TODO: mixed separators
+        'Checking {} ...'.format(test_file)
+    ]
+
+
 @pytest.mark.skip
 def test_config_lookup(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
@@ -318,7 +483,6 @@ def test_config_lookup(tmpdir):
     ]
 
 
-# TODO: test with FILESDIR
 def test_config_lookup_notfound(tmpdir):
     test_file = os.path.join(tmpdir, 'test.c')
     with open(test_file, 'wt'):
@@ -333,4 +497,7 @@ def test_config_lookup_notfound(tmpdir):
         "looking for '{}cppcheck.cfg'".format(exepath_sep),
         'no configuration found',
         'Checking {} ...'.format(test_file)
-    ]
+    ]
+
+# TODO: test with FILESDIR
+# TODO: test with extension already in place