board_expectations.h

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 3
 * 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/>.
 */
 
#pragma once
 
 
#include <memory>
#include <string>
#include <vector>
 
#include <json_common.h>
 
 
class BOARD;
 
namespace KI_TEST
{

class BOARD_EXPECTATION
{
public:
    // This class can be handled via the base class pointer
    virtual ~BOARD_EXPECTATION() = default;
 
    virtual void RunTest( const BOARD& aBrd ) const = 0;
 
    virtual std::string GetName() const = 0;

    void               SetComment( std::string aComment ) { m_Comment = std::move( aComment ); }
    const std::string& GetComment() const { return m_Comment; }
 
private:
    std::string m_Comment;
};
 
 
class BOARD_EXPECTATION_TEST
{
public:
    struct DESCRIPTOR
    {
        std::string m_TestName;
        std::vector<std::string> m_Tags;
        const nlohmann::json& m_TestJson;
    };
 
    BOARD_EXPECTATION_TEST( const std::string& aBrdName ) :
            m_BrdName( aBrdName )
    {
    }

    void RunTest( const BOARD& aBrd ) const;
 
    static std::unique_ptr<BOARD_EXPECTATION_TEST> CreateFromJson( const std::string&    aBrdName,
                                                                   const nlohmann::json& aBrdExpectations );

    static std::vector<DESCRIPTOR> ExtractExpectationTestsFromJson( const nlohmann::json& aExpectationArray );

    static void RunFromRef( const std::string& aBrdName, const BOARD& aBoard,
                            const BOARD_EXPECTATION_TEST::DESCRIPTOR& aExpectationTestRef );
 
private:
    std::unique_ptr<BOARD_EXPECTATION> m_expectation;
    std::string                        m_BrdName;
    bool                               m_skip = false;
};
 
} // namespace KI_TEST