读取配置文件的类的单元测试

Question

我有一个“配置”类，它有一个方法“getConfig”，它读取一个配置文件“config.ini”，其中我有所有应用程序配置（数据库凭据和主机，一些 api 密钥，......）

现在我有这个单元测试来测试配置文件中是否存在数据库条目，同时确认方法“getConfig”返回的数组具有键“database”：

function testConfigFileHasDatabaseEntry()
{
    $configuration = Configuration::getInstance();
    $arrConfig = $configuration->getConfig();
    $this->assertArrayHasKey('database', $arrConfig);
}

我还有另一个单元测试确认“getConfig”返回一个数组类型的变量。

我的问题如下： 就单元测试最佳实践而言，在这种情况下，这个测试是否足以确认函数 getConfig 是否经过良好测试，或者最好确认每个键都存在于配置文件中。我认为确认所有条目都在配置文件中可能属于另一类测试，但我想确定。

让我知道在这种情况下最佳做法是什么。

基于 gcontrollez 的回答，我意识到最好发布类源代码：

<?php
/**
 * Loads the configuration file
 */

namespace Example\Lib;

class Configuration {

    private static $instance;

    private $arrConfig;

    /**
     * Constructor: loads the config file into property arrConfig and dies if unable
     * to load config file
     * 
     * @return void
     */
    private function __construct()
    {
        $this->arrConfig = parse_ini_file("config/settings.ini", true);
        if ($this->arrConfig == false){
            die("Cannot load configuration file");
        }   
    }

    /**
     * returns an instance of this singleton class
     * 
     * @return Configuration
     */
    public static function getInstance()
    {
        if (self::$instance == null){
            self::$instance = new Configuration();
        }
        return self::$instance;
    }

    /**
     * Getter for the property arrConfig
     *
     * @return array:
     */
    public function getConfig() {
        return $this->arrConfig;
    }   

}

谢谢

Answer 1

您没有对getConfig 方法进行单元测试。您只是在检查其结果是否包含某些数据。这是完全有效的，可能很有用，但不是单元测试。

如果您想对getConfig 方法进行单元测试，您应该检查每个可能的config.ini 文件的行为。我想您正在使用getConfig 中的parse_ini_file 函数。因此，为了对getConfig 方法进行单元测试，您应该检查所有您认为可能发生的情况：

- testConfigFileIsLoaded
- testExceptionThrownIfConfigFileFailsToLoad

parse_ini_file 返回一个数组或 false，因此您应该检查这些情况。

为此，您需要能够更改要使用的.ini 文件。如果它在 Configuration 类中被硬编码，你将无法做到这一点。