Python脚本读取Consul配置信息

先来说一下背景，为什么要写脚本去读Consul的配置信息呢？Consul是啥呢？consul是google开源的一个使用go语言开发的服务发现、配置管理中心服务。目前公司用的是这个东西去管理项目上的一些配置信息。公司的环境是通过docker镜像的方式去部署的，镜像是通过rancher去进行管理的。这一套东西面临的一个问题是：服务每次更新之后，服务对应的ip地址是动态变化的。每次需要使用swagger去测接口的时候，都要去rancher上去重新找新的ip地址，比较麻烦。正好呢，最近部门在考虑准备做接口自动化测试，到时候ip总是变的问题也是需要解决的，因此，就先写个脚本调接口获取配置信息，拿到某个服务的ip和端口信息。顺带的把swagger地址也打印出来，以后要访问某个服务的swagger地址就方便很多了。

python读取Consul配置信息的话，用到的是python-consul库，在使用前，需要先安装一下对应的插件。

pip install python-consul
 

封装好的读取consul配置的类如下：

以下脚本中定义的函数，暂时只做数据打印，并未返回具体的数据，因为不同的consul地址，上面的配置信息其实还需要做处理，比如我这次主需要取出一些部署的服务的ip和端口信息，但是consul上面还有一些其他的配置信息，是可以过滤掉的。并且，有的配置项可能由于配置错误，会存在重复的配置，暂时没有删除，这种的话，后续可以在脚本中根据返回的相关字段，去取有效的配置信息。

  

   

    

     

    
    

     

      import consul
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      class RFConsul(object):
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     
    def __init__(self, host, port):
     
    
   

    

     

    
    

     
        """初始化，连接consul服务器"""
     
    
   

    

     

    
    

     

              self._client = consul.Consul(host, port, scheme='http', verify=False)
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     
    def getAllServices(self):
     
    
   

    

     

    
    

     

              services = self._client.agent.services()
     
    
   

    

     

    
    

     
        for i in services:
     
    
   

    

     

    
    

     

                  service = services.get(i)
     
    
   

    

     

    
    

     
            print({service['Service']: service})
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     
    def getServiceByName(self, service_name):
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

              data = self._client.catalog.service(service_name)
     
    
   

    

     

    
    

     
        for value in data[1]:
     
    
   

    

     

    
    

     
            print(service_name + "服务的swagger地址: " + "http://" + value['ServiceAddress'] + ":" + str(value['ServicePort']) + "/swagger-ui.html")
     
    
  
 

getServiceByName：根据服务名，调用后，直接打印拼接好的swagger-ui的访问地址。

getAllServices：打印某个consul地址下的所有配置信息。

调用方式：

  

   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      host = "127.0.0.1"  # consul服务器的ip
     
    
   

    

     

    
    

     

      port = "8500"  # consul服务器对外的端口
     
    
   

    

     

    
    

     

      consul_client = RFConsul(host, port)
     
    
   

    

     

    
    

     

      consul_client.getAllServices()
     
    
   

    

     

    
    

     

      res = consul_client.getServiceByName("xxx-servicename") # 输入配置项的名称
     
    
  
 

调用后，直接得到类似下图的swagger访问地址是不是很香：

然后，在公司中的话，像这种配置中心的地址一般都需要通过代理才能访问，公司用的是socket5的代理，一般在调用脚本的时候要把代理软件打开。也可以在脚本中添加socket代理的配置信息：

  

   

    

     

    
    

     
 import socket
     
    
   

    

     

    
    

     
 import socks
     
    
   

    

     

    
    

     

       socks.set_default_proxy(socks.SOCKS5, "ip", port)
     
    
   

    

     

    
    

     

       socket.socket = socks.socksocket
     
    
  
 

能阅读到此文的一定是小博的铁粉，可以添加一下好友(xiaobotester)，没事的时候互相交流学习哟。如果你是还没入门或者正准备入门软件测试行业的，或者从事数据测试相关的工作的，都可以找我来取取经喔。

文章来源: xiaobotester.blog.csdn.net，作者：小博测试成长之路，版权归原作者所有，如需转载，请联系作者。

原文链接：xiaobotester.blog.csdn.net/article/details/121072499