AutoLine源码分析之配置管理

什么是AutoLine开源平台

AutoLine开源平台是一个开源自动化测试解决方案，基于RobotFramework进行二次开发，支持RobotFramework几乎所有的库。

github地址：https://github.com/small99/AutoLine

码云地址： https://gitee.com/lym51/AutoLine

源码路径

注： 由.env做配置，config.py实现配置读取

.env配置文件

# 指定加载运行环境develpment-开发配置，production-生产配置，default-默认为开发

AUTOBEAT_CONFIG=production

# 服务启动加密

SECRET_KEY=FJWEOIO138989340SNNFISLDNFIOWFNSNALFKNSDLKF

# smtp相关配置

MAIL_SERVER=

MAIL_PORT=587

MAIL_USERNAME=

MAIL_PASSWORD=25

FLASKY_MAIL_SUBJECT_PREFIX=[AutoLine]

FLASKY_MAIL_SENDER=AutoLine Admin

# 默认admin账号

FLASKY_ADMIN=autoline@126.com

# 数据库配置

DATABASE_URL=mysql+mysqlconnector://root:123456@127.0.0.1/autoline

# 调度数据库配置

TRIGGER_DATABASE_URL=mysql+mysqlconnector://root:123456@127.0.0.1/autoline

注：

可以通过指定DATABASE_URL和TRIGGER_DATABASE_URL实现将业务库和调度库分离

数据库相关配置遵循SQLALchemy的连接字符串原则，支持sqlite、mysql、mssql、mangodb等数据库，并支持指定不同的驱动库

数据库连接字符串格式：

数据库+驱动://账号:密码@ip:端口/数据库名称 即：

mysql+mysqldb://:

@[:

]/

端口默认为3306着不用指明。

以MySQL为例，指定不同的驱动的方式连接字符串示例：

使用pymysql为驱动

mysql+pymysql://root:123456@127.0.0.1:3306/autoline

使用MySQL-Connetor为驱动

mysql+msyqlconnector://root:123456@127.0.0.1:3306/autoline

使用MySQL-Python为驱动

mysql+mysqldb://root:123456@127.0.0.1:3306/autoline

config.py源码

config.py源码的结构如下图

定义了几个全局变量和一个Config（配置管理基类）类，和DevelopmentConfig（开发环境配置管理）和ProductionConfig(生产模式配置管理)类

下面对config.py源码进行分析

# -*- coding: utf-8 -*-

__author__ ="苦叶子"

"""

公众号: 开源优测

Email: lymking@foxmail.com

"""

importos

importrandom

importcodecs

basedir = os.path.abspath(os.path.dirname(__file__))

choice = ("QWERTYUIOPASDFGHJKLMNBVCXZqazxswedcvfrtgbnhyujmkiolp1234567890!@#$%^&*")

classConfig:

# 判断.env配置文件是否存在，存在则将配置导入至环境变量

ifos.path.exists('.env'):

print('Import environment from .env')

forlineincodecs.open('.env'):

var = line.strip().split('=')

iflen(var) ==2:

os.environ[var[]] = var[1]

#print(var[0] + "=" + var[1])

# 读取配置环境变量中的配置项数据

SECRET_KEY = os.environ.get('SECRET_KEY')# or random.choices(choice, k=16)

MAIL_SERVER = os.environ.get('MAIL_SERVER','smtp.126.com')

MAIL_PORT =int(os.environ.get('MAIL_PORT','587'))

MAIL_USE_TLS = os.environ.get('MAIL_USE_TLS','true').lower()in['true','on','1']

MAIL_USERNAME = os.environ.get('MAIL_USERNAME')

MAIL_PASSWORD = os.environ.get('MAIL_PASSWORD')

FLASKY_MAIL_SUBJECT_PREFIX = os.environ.get('FLASKY_MAIL_SUBJECT_PREFIX')

FLASKY_MAIL_SENDER = os.environ.get('FLASKY_MAIL_SENDER')

FLASKY_ADMIN = os.environ.get('FLASKY_ADMIN')

SSL_REDIRECT =False

SQLALCHEMY_TRACK_MODIFICATIONS =False

SQLALCHEMY_RECORD_QUERIES =True

FLASKY_POSTS_PER_PAGE =20

FLASKY_FOLLOWERS_PER_PAGE =50

FLASKY_COMMENTS_PER_PAGE =30

FLASKY_SLOW_DB_QUERY_TIME =0.5

# 自定义参数

AUTO_LOGS = os.environ.get('AUTO_LOGS')

AUTO_REPORT = os.environ.get('AUTO_REPORT')

RUNNERS = []

TRIGGER =None

@staticmethod

definit_app(app):

pass

classDevelopmentConfig(Config):

# 启用调试模式

DEBUG =True

# 使用sqlite作为开发环境的数据库

SQLALCHEMY_DATABASE_URI ='sqlite:///'+ os.path.join(basedir,'AutoLine-dev.sqlite')#os.environ.get('DEV_DATABASE_URL')

TRIGGER_DATABASE_URL ='sqlite:///'+ os.path.join(basedir,'AutoLine-dev.sqlite')

classProductionConfig(Config):

# 禁用调试模式

DEBUG = False

# 读取配置中的数据库连接

SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') +"?charset=utf8"# or 'sqlite:///' + os.path.join(basedir, 'AutoLine.sqlite')

#SQLALCHEMY_ECHO = True

TRIGGER_DATABASE_URL = os.environ.get('TRIGGER_DATABASE_URL')

@classmethod

definit_app(cls,app):

Config.init_app(app)

# 发送初始化错误信息给管理员

importlogging

fromlogging.handlersimportSMTPHandler

credentials =None

secure =None

ifgetattr(cls,'MAIL_USERNAME', None)is not None:

credentials = (cls.MAIL_USERNAME,cls.MAIL_PASSWORD)

ifgetattr(cls,'MAIL_USE_TLS', None):

secure = ()

mail_handler = SMTPHandler(

mailhost=(cls.MAIL_SERVER,cls.MAIL_PORT),

fromaddr=cls.FLASKY_MAIL_SENDER,

toaddrs=[cls.FLASKY_ADMIN],

subject=cls.FLASKY_MAIL_SUBJECT_PREFIX +' AutoLine Startup Error',

credentials=credentials,

secure=secure)

mail_handler.setLevel(logging.ERROR)

app.logger.addHandler(mail_handler)

# 定义不同环境的配置

config = {

"development": DevelopmentConfig,

"production": ProductionConfig,

"default": DevelopmentConfig

}

# 关键字自定义配置

USER_KEYS = {

"web": ["BuiltIn","Collections","String","DateTime","Screenshot","SeleniumLibrary"],

"app": ["BuiltIn","Collections","String","DateTime","Screenshot","AppiumLibrary"],

"http": ["BuiltIn","Collections","String","DateTime","RequestsLibrary"],

"all": ["BuiltIn","Collections","String","Screenshot","DateTime",

"SeleniumLibrary","AppiumLibrary","RequestsLibrary",

"Process","Telnet","OperatingSystem"]

}

AutoLine的配置管理是相对比较简单的，通过将.env中的配置写入环境变量中，再通过读取环境变量中配置项的方式实现读取，根据AUTOBEAT_CONFIG配置指定的环境来加载不同的连接库。

动动手指往下点点点点***，你懂的