跳转到主要内容

支持OAuth2的Robot Framework扩展HTTP客户端测试库

项目描述

Build Status Code Coverage Code Grade Keyword Documentation Package Version Development Status Python Version Monthly Download License

简介

ExtendedRequestsLibrary是一个扩展的HTTP客户端库,用于Robot Framework,支持OAuth2,并利用requests项目、requests-oauthlib项目和RequestsLibrary项目。

有关此库的更多信息,请参阅关键字文档

示例

*** Settings ***
Library    ExtendedRequestsLibrary

*** Test Cases ***
Post Request With Client Credentials
    Create Client OAuth2 Session    client    https://token    key    secret    base_url=https://service
    ${var} =    Post Request    client    /endpoint    json=${“key": "value"}
    Log    ${var}
    Delete All Sessions

Post Request With Password
    Create Password OAuth2 Session    member    https://token    key    secret    usn    pwd    base_url=https://service
    ${var} =    Post Request    member    /endpoint    json=${“key": "value"}
    Log    ${var}
    &{files} =    Create Dictionary    file1=/path/to/a_file.ext    file2=/path/to/another_file.ext
    ${var} =    Post Request    member    /endpoint    files=&{files}
    Log    ${var}
    Delete All Sessions

安装

使用 pip

推荐的安装方法是使用pip

pip install robotframework-extendedrequestslibrary

使用pip的主要好处是它会自动安装库所需的所有依赖项。其他优点包括易于升级和支持卸载

pip install --upgrade robotframework-extendedrequestslibrary
pip uninstall robotframework-extendedrequestslibrary

注意,使用上面的--upgrade会同时更新库及其所有依赖项到最新版本。如果您愿意,您也可以安装特定版本或仅升级库使用的requests项目

pip install robotframework-extendedrequestslibrary==x.x.x
pip install --upgrade requests
pip install requests==x.x.x

代理配置

如果您位于代理服务器之后,可以使用 --proxy 命令行选项,或设置 http_proxy 和/或 https_proxy 环境变量来配置 pip 使用它。如果您位于需要身份验证的NTLM代理之后,可能需要考虑安装 CNTML 来处理与其通信。

有关 --proxy 选项和在使用代理时使用 pip 的更多信息,请参阅

手动安装

如果您没有网络连接或无法使代理工作,您需要求助于手动安装。这需要您自己安装库及其依赖项。

gpg --keyserver pgp.mit.edu --search-keys D1406DE7
  • 从列表中选择数字以导入公钥

  • 验证包与其实际 PGP 签名的一致性

gpg --verify robotframework-extendedrequestslibrary-x.x.x.tar.gz.asc robotframework-extendedrequestslibrary-x.x.x.tar.gz
  • 将每个源分发版提取到临时位置。

  • 使用以下命令从命令行进入每个创建的目录并安装每个项目:

python setup.py install

如果您使用的是 Windows,并且某些项目提供了 Windows 安装程序,您可以使用它们而不是源分发版。只需根据您的系统下载32位或64位安装程序,双击它,并按照说明操作即可。

目录布局

doc/

关键字文档

src/

Python 源代码

test/

测试文件

utest/

Python 单元测试

使用方法

要使用 Robot Framework 和 ExtendedRequestsLibrary 编写测试,ExtendedRequestsLibrary 必须导入到您的 Robot 测试套件中。

*** Settings ***
Library    ExtendedRequestsLibrary

有关更多信息,请参阅 Robot Framework 用户指南

有关 Robot Framework 标准库和内置工具的更多信息,请参阅 Robot Framework 文档

构建关键字文档

您可以在网上找到 关键字文档,如果需要生成关键字文档,请运行

make doc

运行单元测试和测试覆盖率报告

测试测试库,关于 dogfooding,让我们运行

make test

贡献

如果您想向 Extended Requests Library 项目贡献代码,您可以通过 GitHub 通过分叉存储库并发送拉取请求来做到这一点。

提交代码时,请尽量遵循现有的约定和样式,以使代码尽可能可读。请还包括适当的测试用例。

在您的代码被接受到项目中之前,您还必须签署 Extended Requests Library CLA(个人贡献者许可协议)。

就这么多!感谢您的贡献!

许可协议

版权(c)2015,2016 Richard Huang。

本库是免费软件,许可证为: GNU Affero 通用公共许可证(AGPL-3.0)

文档和其他类似内容在 Creative Commons 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 下提供。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分发

robotframework-extendedrequestslibrary-0.5.5.zip (85.2 kB 查看哈希值)

上传时间 源代码

robotframework-extendedrequestslibrary-0.5.5.tar.gz (73.3 kB 查看哈希值)

上传时间 源代码

由以下组织支持