Python接口自动化测试的学习笔记9——logging日志

1、引言

在进行Python接口自动化测试时，日志记录是一项至关重要的任务，它可以帮助开发者追踪测试过程中的详细信息，包括请求与响应数据、错误消息、调试信息等，从而有效地定位问题并提高测试效率。下面，我们将探讨如何在Python接口自动化测试项目中构建和配置一个强大的日志记录系统。

2、引入logging模块

首先，我们需要初始化logging模块并设置相关配置。基本步骤包括定义日志级别、日志格式和日志输出位置。例如：

# filepath = './common/logging.py'
import os
import logging.handlers


class GetLogger:
    """
    当已经创建了logger对象的时候，那么之后就不在创建了，也就是只创建一次对象
    """
    # 把logger对象的初始值设置为None
    logger = None

    # 创建logger，并且返回这个logger
    @classmethod
    def get_logger(cls):
        # 判断日志器为空
        if cls.logger is None:
            # 创建日志器，控制他的创建次数
            cls.logger = logging.getLogger('Test_API')  # 这里的值是自定义的
            # 设置日志级别，debug/info/warning/error
            cls.logger.setLevel(logging.DEBUG)  # 设置debug级别，意味着高于debug的都会被收集
            # 2.获取格式器
            # 2.1 要给格式器设置要输出的样式
            fmt = "%(asctime)s %(levelname)s [%(name)s] [%(filename)s (%(funcName)s:%(lineno)d)] - %(message)s"
            # 2.2 创建格式器，并且给他设置样式
            fm = logging.Formatter(fmt)
            # 获取项目路径
            project_path = os.path.dirname(os.path.abspath(__file__)).replace("common", "")
            # 3.创建处理器 按照时间进行切割文件
            tf = logging.handlers.TimedRotatingFileHandler(filename=project_path + f'/logs/requests.log',  # 原日志文件
                                                           when='midnight',  # 间隔多长时间把日志存放到新的文件中
                                                           interval=1,
                                                           backupCount=7,  # 除了原日志文件，还有7个备份
                                                           encoding='utf-8'
                                                           )
            logging.basicConfig(level=logging.DEBUG, format=fmt)  # 这是在控制台上打印日志信息

            def namer(filename):
                dir_name, base_name = os.path.split(filename)
                base_name = base_name.replace('requests.log.', 'requests')
                rotation_filename = os.path.join(dir_name, base_name)
                return rotation_filename

            tf.namer = namer
            tf.suffix = "_%Y-%m-%d_%H-%M-%S.log"
            # 在处理器中添加格式器
            tf.setFormatter(fm)
            # 在日志器中添加处理器
            cls.logger.addHandler(tf)

        # return cls.logger
        return cls.logger

（注意：需要先在根目录下创建logs目录，日志才会保存在logs目录下）

3、在接口测试中应用logging

接下来，在实际的接口自动化测试代码中，我们可以利用这个logger实例来记录HTTP请求和响应的关键信息，直接在接口统一请求方法中引用：

# filepath = './common/requests_utils.py'
import requests
from requests import ReadTimeout, RequestException

from common.logger import GetLogger


class RequestsUtil:

    def __init__(self):
        """session管理器"""
        # 实例化session
        self.session = requests.session()
        self.logger = GetLogger.get_logger()

    # 统一请求封装
    def send_request(self, method, url, headers=None, params=None, data=None, json=None, **kwargs):
        """
            统一封装HTTP请求方法
            :param method: 请求方法，如'GET', 'POST', 'PUT', 'DELETE'等
            :param url: 请求URL
            :param headers: 请求头信息，可选参数
            :param params: URL查询参数，适用于GET请求，可选参数
            :param data: 发送的数据，适用于POST等请求，可选参数
            :param json: 以json格式发送的数据，适用于POST等请求，可选参数
            :return: 返回requests库的Response对象
            """
        try:
            response = self.session.request(method, url, headers=headers, params=params, data=data, json=json, **kwargs)
            res_json = response.json()
            res_code = response.json()['code']
            self.logger.info(f'接口请求地址：{url}')
            print('接口请求地址：', url)
            self.logger.info(f'接口请求方式：{method}')
            print('接口请求方式：', method)
            self.logger.info(f'接口请求主体：{kwargs}')
            print('接口请求主体：', kwargs)
            self.logger.info(f'接口返回状态码：{res_code}')
            print('接口返回状态码', res_code)
            self.logger.info(f'接口返回信息：{res_json}')
            print('接口返回信息', res_json)
            return response
        except ReadTimeout:
            self.logger.error(u"请求超时")
        except ConnectionError:
            self.logger.error(u"请求连接错误")
        except RequestException:
            self.logger.error(u"返回错误")

最后，查看下执行结果，控制台已经打印了相关信息，logs目录下也生成了log日志文件

4、结论

通过上述方法，我们不仅能在Python接口自动化测试中实现对每一步操作的精确记录，而且可以根据不同需求灵活调整日志级别，确保既能满足日常调试需求，又不会因过多日志而影响性能。这样构建的日志系统有助于团队快速定位问题，提高测试效率，同时也为后期的性能分析、回归测试和持续集成提供了有力的支持。因此，在接口自动化测试实践中，合理运用logging模块进行日志管理是十分重要的实践策略。