test_filename_resolver.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
#include <qa_utils/wx_utils/unit_test_utils.h>
 
// Code under test
#include <filename_resolver.h>
#include <search_stack.h>
 
#include <wx/filename.h>
 
#include <filesystem>
#include <fstream>
 
namespace fs = std::filesystem;
 
BOOST_AUTO_TEST_SUITE( FilenameResolver )
 
BOOST_AUTO_TEST_CASE( ResolveAbsoluteAndWorkingPath )
{
    fs::path temp = fs::temp_directory_path() / "fnres_test";
    fs::create_directories( temp );
 
    fs::path work = temp / "work";
    fs::create_directories( work );
 
    fs::path file = work / "model.txt";
    std::ofstream( file.string() ) << "dummy";
 
    FILENAME_RESOLVER resolver;
 
    wxString   absFile = wxString::FromUTF8( file.string() );
    wxString   resolved = resolver.ResolvePath( absFile, wxEmptyString, {} );
    wxFileName fn( absFile );
    fn.Normalize( wxPATH_NORM_ABSOLUTE | wxPATH_NORM_DOTS );
    BOOST_CHECK_EQUAL( resolved, fn.GetFullPath() );
 
    wxString working = wxString::FromUTF8( work.string() );
    wxString relResolved = resolver.ResolvePath( wxS( "model.txt" ), working, {} );
    BOOST_CHECK_EQUAL( relResolved, fn.GetFullPath() );
}
 
BOOST_AUTO_TEST_CASE( ResolveAliasAndErrors )
{
    fs::path temp = fs::temp_directory_path() / "fnres_alias";
    fs::create_directories( temp );
 
    fs::path file = temp / "a.txt";
    std::ofstream( file.string() ) << "dummy";
 
    FILENAME_RESOLVER resolver;
 
    SEARCH_PATH sp;
    sp.m_Alias = wxS( "ALIAS" );
    sp.m_Pathvar = wxString::FromUTF8( temp.string() );
    std::vector<SEARCH_PATH> paths = { sp };
    resolver.UpdatePathList( paths );
 
    // canonical ALIAS:path format (no leading colon)
    wxString resolved = resolver.ResolvePath( wxS( "ALIAS:a.txt" ), wxEmptyString, {} );
    BOOST_CHECK_EQUAL( resolved, wxString::FromUTF8( file.string() ) );
 
    // legacy :ALIAS:path format (leading colon)
    wxString resolvedLeadingColon = resolver.ResolvePath( wxS( ":ALIAS:a.txt" ), wxEmptyString, {} );
    BOOST_CHECK_EQUAL( resolvedLeadingColon, wxString::FromUTF8( file.string() ) );
 
    // unknown alias returns empty
    wxString missing = resolver.ResolvePath( wxS( "MISSING:a.txt" ), wxEmptyString, {} );
    BOOST_CHECK( missing.IsEmpty() );
}
 
// Verify that ShortenPath outputs ${ALIAS}/path and that the result round-trips through ResolvePath.
BOOST_AUTO_TEST_CASE( ShortenPathRoundTrip )
{
    fs::path temp = fs::temp_directory_path() / "fnres_shorten";
    fs::create_directories( temp );
 
    fs::path file = temp / "sub" / "model.wrl";
    fs::create_directories( file.parent_path() );
    std::ofstream( file.string() ) << "dummy";
 
    FILENAME_RESOLVER resolver;
 
    SEARCH_PATH sp;
    sp.m_Alias = wxS( "MYLIB" );
    sp.m_Pathvar = wxString::FromUTF8( temp.string() );
    resolver.UpdatePathList( { sp } );
 
    wxString full = wxString::FromUTF8( file.string() );
    wxString shortened = resolver.ShortenPath( full );
 
    // ShortenPath produces ${ALIAS}/path for user-defined aliases
    BOOST_CHECK( shortened.StartsWith( wxS( "${MYLIB}/" ) ) );
 
    // The shortened path must resolve back to the original file
    wxString resolvedBack = resolver.ResolvePath( shortened, wxEmptyString, {} );
    wxFileName fn( full );
    fn.Normalize( wxPATH_NORM_ABSOLUTE | wxPATH_NORM_DOTS );
    BOOST_CHECK_EQUAL( resolvedBack, fn.GetFullPath() );
}
 
// Backward compatibility: files saved by older KiCad versions with :ALIAS:path format
// for user-defined aliases must still resolve correctly.
BOOST_AUTO_TEST_CASE( ResolveBackCompatColonAlias )
{
    fs::path temp = fs::temp_directory_path() / "fnres_colon_alias";
    fs::create_directories( temp );
 
    fs::path file = temp / "model.wrl";
    std::ofstream( file.string() ) << "dummy";
 
    FILENAME_RESOLVER resolver;
 
    SEARCH_PATH sp;
    sp.m_Alias = wxS( "MYLIB" );
    sp.m_Pathvar = wxString::FromUTF8( temp.string() );
    resolver.UpdatePathList( { sp } );
 
    // :MYLIB:model.wrl is the legacy format produced by KiCad before e7d6c84aef
    wxString resolved = resolver.ResolvePath( wxS( ":MYLIB:model.wrl" ), wxEmptyString, {} );
    wxFileName fn( wxString::FromUTF8( file.string() ) );
    fn.Normalize( wxPATH_NORM_ABSOLUTE | wxPATH_NORM_DOTS );
    BOOST_CHECK_EQUAL( resolved, fn.GetFullPath() );
}
 
BOOST_AUTO_TEST_SUITE_END()
 
BOOST_AUTO_TEST_SUITE( SearchStack )
 
BOOST_AUTO_TEST_CASE( RelativePathResolution )
{
    fs::path root = fs::temp_directory_path() / "ss_root";
    fs::path sub = root / "sub";
    fs::create_directories( sub );
 
    fs::path file = sub / "f.txt";
    std::ofstream( file.string() ) << "dummy";
 
    SEARCH_STACK stack;
    stack.AddPaths( wxString::FromUTF8( root.string() ) );
 
    wxString rel = stack.FilenameWithRelativePathInSearchList( wxString::FromUTF8( file.string() ),
                                                               wxString::FromUTF8( root.string() ) );
    BOOST_CHECK_EQUAL( rel, wxString::FromUTF8( ( fs::path( "sub" ) / "f.txt" ).string() ) );
 
    fs::path outside = fs::temp_directory_path() / "outside.txt";
    std::ofstream( outside.string() ) << "dummy";
 
    wxString full = stack.FilenameWithRelativePathInSearchList( wxString::FromUTF8( outside.string() ),
                                                                wxString::FromUTF8( root.string() ) );
    BOOST_CHECK_EQUAL( full, wxString::FromUTF8( outside.string() ) );
}
 
BOOST_AUTO_TEST_SUITE_END()