<?php
/*
 * Copyright 2005-2019 Centreon
 * Centreon is developed by : Julien Mathis and Romain Le Merlus under
 * GPL Licence 2.0.
 *
 * 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.
 *
 * 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 <http://www.gnu.org/licenses>.
 *
 * Linking this program statically or dynamically with other modules is making a
 * combined work based on this program. Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this program give Centreon
 * permission to link this program with independent modules to produce an executable,
 * regardless of the license terms of these independent modules, and to copy and
 * distribute the resulting executable under terms of Centreon choice, provided that
 * Centreon also meet, for each linked independent module, the terms  and conditions
 * of the license of that module. An independent module is a module which is not
 * derived from this program. If you modify this program, you may extend this
 * exception to your version of the program, but you are not obliged to do so. If you
 * do not wish to do so, delete this exception statement from your version.
 *
 * For more information : contact@centreon.com
 *
 *
 */

namespace Centreon\Tests\Resources;

use PHPUnit\Framework\TestCase;

/**
 * This class help to test list of callbacks or methods if they were executed
 *
 * <example>
 * class MyTest extends TestCase
 * {
 *      public testMethod()
 *      {
 *          $checkpoint = (new CheckPoint)
 *              ->add('point1');
 *      }
 * }
 * </example>
 */
class CheckPoint
{
    /**
     * @var array
     */
    protected $points;

    /**
     * Add point
     *
     * @param string $name
     * @return void
     */
    public function add($name): self
    {
        $this->points[$name] = false;

        return $this;
    }

    /**
     * Mark point as executed
     *
     * @param $name
     * @return void
     */
    public function mark($name): void
    {
        $this->points[$name] = true;
    }

    /**
     * Check list of points
     *
     * @param \PHPUnit\Framework\TestCase $testCase
     */
    public function assert(TestCase $testCase): void
    {
        $expected = [];

        foreach ($this->points as $key => $val) {
            $expected[$key] = true;
        }

        $testCase->assertEquals($expected, $this->points);
    }
}
