如何Mock elasticsearch-py调用以避免真实Elasticsearch集群请求？

看起来你遇到的核心问题是Mock的路径不对，导致测试代码没有覆盖到实际业务代码中使用的Elasticsearch实例。我们来一步步分析原因并给出针对性的解决方案：

问题根源 #

你尝试patch elasticsearch5.Elasticsearch这个全局类，但你的Escli._es是类属性——在main.py模块加载时就已经完成了实例化。这时候测试中patch全局类，根本不会影响已经存在的Escli._es实例，它依然是真实的Elasticsearch对象，自然会发起真实HTTP请求。

另外，你提到无法直接patch Escli._es.cluster.get_settings，大概率是因为没有写对Python Mock要求的精确调用路径。

解决方案 #

根据你的代码结构，这里提供几种可靠的Mock方式：

方案1：直接替换Escli类的_es属性 #

既然Escli._es是类属性，我们可以直接用Mock对象替换它，所有依赖Escli._es的代码都会自动使用这个Mock实例：

from unittest.mock import patch, Mock
from main import Escli
from settings import ClusterSettings

def test_cluster_settings():
    # 构建Mock的集群对象，定义get_settings的返回值
    mock_cluster = Mock()
    mock_cluster.get_settings.return_value = {
        "persistent": {"cluster.name": "test-cluster"}
    }
    
    # 构建Mock的Elasticsearch实例，关联集群对象
    mock_es = Mock()
    mock_es.cluster = mock_cluster
    
    # 替换Escli类的_es属性
    with patch.object(Escli, "_es", mock_es):
        # 调用被测试的方法
        result = ClusterSettings.get()
        
        # 断言结果符合预期
        assert result == {"persistent": {"cluster.name": "test-cluster"}}
        # 验证目标方法确实被调用过
        mock_cluster.get_settings.assert_called_once()

方案2：Patch实际调用的方法路径 #

如果ClusterSettings.get直接调用Escli._es.cluster.get_settings，可以直接patch这个方法的完整路径：

from unittest.mock import patch
from settings import ClusterSettings

def test_cluster_settings():
    with patch("main.Escli._es.cluster.get_settings") as mock_get:
        # 设置Mock的返回值
        mock_get.return_value = {"transient": {"indices.refresh_interval": "1s"}}
        
        result = ClusterSettings.get()
        
        assert result == {"transient": {"indices.refresh_interval": "1s"}}
        mock_get.assert_called_once()

方案3：Patch Escli模块中的Elasticsearch类（适用于_es在__init__中实例化的场景） #

如果你的Escli._es是在类的__init__方法中创建的（而非模块加载时就实例化的类属性），可以patchmain模块中导入的Elasticsearch类来拦截实例化：

from unittest.mock import patch, Mock
from main import Escli
from settings import ClusterSettings

def test_cluster_settings():
    with patch("main.elasticsearch5.Elasticsearch") as mock_es_class:
        # 配置Mock实例的cluster.get_settings返回值
        mock_es_instance = Mock()
        mock_es_instance.cluster.get_settings.return_value = {"persistent": {"test_key": "test_val"}}
        mock_es_class.return_value = mock_es_instance
        
        # 实例化Escli（如果需要）
        app = Escli()
        result = ClusterSettings.get()
        
        assert result == {"persistent": {"test_key": "test_val"}}
        mock_es_class.assert_called_once()
        mock_es_instance.cluster.get_settings.assert_called_once()

关键注意点 #

• Mock路径必须精确匹配：Python的Mock遵循"使用位置优先"原则，即你需要patch的是代码实际调用对象的路径，而非对象定义的路径。比如如果settings.py是从main导入Escli并使用Escli._es，那就要patchmain.Escli._es相关路径，而非全局的elasticsearch5.Elasticsearch。
• 类属性vs实例属性：如果_es是类属性（类定义时直接赋值），模块加载时就会生成真实实例，必须直接替换这个类属性；如果是实例属性（在__init__中赋值），则可以通过patch模块中的Elasticsearch类来拦截实例化。

内容的提问来源于stack exchange，提问作者Jérôme Pin