test_jobs_output_archive.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 <boost/test/unit_test.hpp>
 
#include <jobs/jobs_output_archive.h>
#include <project.h>
 
#include <wx/file.h>
#include <wx/filename.h>
 
 
BOOST_AUTO_TEST_SUITE( JobsOutputArchive )
 
 
class TEST_PROJECT : public PROJECT
{
public:
    explicit TEST_PROJECT( const wxString& aPath ) : m_path( aPath ) {}
 
    const wxString GetProjectFullName() const override { return m_path + wxS( "test.kicad_pro" ); }
 
private:
    wxString m_path;
};
 

BOOST_AUTO_TEST_CASE( RelativeDestinationResolvesAgainstProject )
{
    wxFileName projectDir;
    projectDir.AssignDir( wxFileName::GetTempDir() );
    projectDir.AppendDir( wxS( "kicad_qa_resolve_project" ) );
 
    TEST_PROJECT project( projectDir.GetPath() + wxFileName::GetPathSeparator() );
 
    wxString resolved = JOBS_OUTPUT_HANDLER::ResolveOutputPath( wxS( "out\\sub/../final.zip" ), &project );
 
    wxFileName expected( projectDir.GetPath(), wxS( "final.zip" ) );
    expected.AppendDir( wxS( "out" ) );
 
    BOOST_CHECK_EQUAL( resolved, expected.GetFullPath() );
}
 

struct ScopedTempDir
{
    explicit ScopedTempDir( const wxString& aTag )
    {
        wxFileName fn;
        fn.AssignDir( wxFileName::GetTempDir() );
        fn.AppendDir( wxString::Format( wxS( "kicad_qa_%s_%p" ), aTag, this ) );
 
        BOOST_REQUIRE( wxFileName::Mkdir( fn.GetPath(), wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) );
        path = fn.GetPath();
    }
 
    ~ScopedTempDir()
    {
        if( !path.IsEmpty() && wxFileName::DirExists( path ) )
            wxFileName::Rmdir( path, wxPATH_RMDIR_RECURSIVE );
    }
 
    wxString path;
};
 

BOOST_AUTO_TEST_CASE( NestedDestinationPathCreatesParents )
{
    ScopedTempDir base( wxS( "archive_nested" ) );
 
    // Populate a temp source directory with a single file to be archived.
    wxString srcDir = base.path + wxFileName::GetPathSeparator() + wxS( "src" );
    BOOST_REQUIRE( wxFileName::Mkdir( srcDir, wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) );
 
    wxString srcFile = srcDir + wxFileName::GetPathSeparator() + wxS( "payload.txt" );
    {
        wxFile f;
        BOOST_REQUIRE( f.Create( srcFile, true ) );
        f.Write( wxS( "hello" ) );
    }
 
    // Destination uses two layers of nesting that do not yet exist.
    wxString nestedDir = base.path + wxFileName::GetPathSeparator() + wxS( "level1" )
                         + wxFileName::GetPathSeparator() + wxS( "level2" );
    wxString outPath = nestedDir + wxFileName::GetPathSeparator() + wxS( "archive.zip" );
 
    BOOST_REQUIRE( !wxFileName::DirExists( nestedDir ) );
 
    JOBS_OUTPUT_ARCHIVE archive;
    archive.SetOutputPath( outPath );
 
    std::vector<wxString>        noOverwriteList;
    std::vector<JOB_OUTPUT>      outputs;
    std::optional<wxString>      resolved;
 
    bool ok = archive.HandleOutputs( srcDir, nullptr, noOverwriteList, outputs, resolved );
 
    BOOST_CHECK_MESSAGE( ok, "Archive job should succeed with a nested destination path." );
    BOOST_CHECK_MESSAGE( wxFileName::DirExists( nestedDir ),
                         "Nested parent directory should have been created." );
    BOOST_REQUIRE( resolved.has_value() );
    BOOST_CHECK( wxFileName::FileExists( resolved.value() ) );
}
 

BOOST_AUTO_TEST_CASE( ExistingDestinationStillWorks )
{
    ScopedTempDir base( wxS( "archive_existing" ) );
 
    wxString srcDir = base.path + wxFileName::GetPathSeparator() + wxS( "src" );
    BOOST_REQUIRE( wxFileName::Mkdir( srcDir, wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) );
 
    wxString srcFile = srcDir + wxFileName::GetPathSeparator() + wxS( "payload.txt" );
    {
        wxFile f;
        BOOST_REQUIRE( f.Create( srcFile, true ) );
        f.Write( wxS( "hello" ) );
    }
 
    wxString outPath = base.path + wxFileName::GetPathSeparator() + wxS( "archive.zip" );
 
    JOBS_OUTPUT_ARCHIVE archive;
    archive.SetOutputPath( outPath );
 
    std::vector<wxString>        noOverwriteList;
    std::vector<JOB_OUTPUT>      outputs;
    std::optional<wxString>      resolved;
 
    bool ok = archive.HandleOutputs( srcDir, nullptr, noOverwriteList, outputs, resolved );
 
    BOOST_CHECK( ok );
    BOOST_REQUIRE( resolved.has_value() );
    BOOST_CHECK( wxFileName::FileExists( resolved.value() ) );
}
 
 
BOOST_AUTO_TEST_SUITE_END()