├── .circleci
└── config.yml
├── .gitignore
├── .travis.yml
├── README.rst
├── USAGE.rst
├── appveyor.yml
├── logs
└── .gitkeep
├── pytest.ini
├── rest-api
├── common
│ └── pest
│ │ ├── .gitignore
│ │ ├── Pest.php
│ │ ├── PestJSON.php
│ │ ├── PestXML.php
│ │ ├── README.markdown
│ │ ├── composer.json
│ │ └── examples
│ │ ├── intouch_example.php
│ │ ├── open_street_map_example.php
│ │ └── rollcall_example.php
├── v1
│ ├── curl
│ │ ├── execution
│ │ │ └── createTestCaseExecution.sh
│ │ ├── generic
│ │ │ └── createTestCaseX.sh
│ │ ├── json
│ │ │ ├── README
│ │ │ ├── createTestCase.json
│ │ │ ├── createTestCaseB.json
│ │ │ ├── createTestCaseExecution.json
│ │ │ ├── createTestCaseWithSteps.json
│ │ │ ├── createTestCaseXL5.json
│ │ │ ├── createTestCaseXL5B.json
│ │ │ ├── createTestCaseXL5C.json
│ │ │ ├── createTestCaseXL5D.json
│ │ │ ├── createTestPlan.json
│ │ │ ├── createTestProject.json
│ │ │ ├── createTestSuite.json
│ │ │ ├── setTestPlanActive.json
│ │ │ ├── setTestPlanInactive.json
│ │ │ ├── setTestPlanNotes.json
│ │ │ ├── setTestPlanPrivate.json
│ │ │ ├── testCaseComplex.json
│ │ │ └── testCaseComplex2.json
│ │ ├── testplan
│ │ │ ├── createTestPlan.sh
│ │ │ ├── setTestPlanActive.sh
│ │ │ ├── setTestPlanInactive.sh
│ │ │ ├── setTestPlanNotes.sh
│ │ │ ├── setTestPlanPrivate.sh
│ │ │ └── updateTestPlan.sh
│ │ └── testproject
│ │ │ ├── createTestCase.sh
│ │ │ ├── createTestCaseWithSteps.sh
│ │ │ ├── createTestProject.sh
│ │ │ ├── createTestSuite.sh
│ │ │ ├── getAllTestProjects.sh
│ │ │ ├── getOneTestProjectByID.sh
│ │ │ ├── getOneTestProjectByName.sh
│ │ │ ├── getTestCasesInTestProject.sh
│ │ │ ├── getTestCasesInTestProjectByTestProjectName.sh
│ │ │ ├── getTestPlansInTestProject.sh
│ │ │ └── getTestPlansInTestProjectByTestProjectName.sh
│ └── php
│ │ ├── execution
│ │ └── createTestCaseExecution.php
│ │ └── testproject
│ │ ├── createTestProject.php
│ │ ├── getProjects.php
│ │ ├── getTestCasesInTestProject.php
│ │ └── getTestPlansInTestProject.php
└── v2
│ ├── README
│ ├── curl
│ ├── builds
│ │ ├── createBuild.sh
│ │ └── createKeyword.sh
│ ├── callisthenics
│ │ ├── README
│ │ └── who.sh
│ └── keywords
│ │ └── createKeyword.sh
│ └── json
│ ├── README
│ ├── createBuild.json
│ ├── createKeyword.json
│ ├── createTestCaseUsingAttrID.json
│ └── createTestCaseUsingAttrVerboseKey.json
├── sample-data
├── README.md
├── RSPEC-01-req-spec.barebones.xml
├── TS-100.barebones.xml
├── images
│ ├── RSPEC-01-req-spec.barebones.png
│ └── TS-100.barebones.png
└── sample-keywords01.xml
├── sample-db
├── mysql
│ ├── README.md
│ └── testlink_30k_testcases.sql.gz
└── postgres
│ ├── README.md
│ └── testlinkP2.tar
├── setup.cfg
├── setup.py
├── testlinktests
├── __init__.py
├── configs
│ ├── __init__.py
│ └── settings.json
└── core
│ ├── __init__.py
│ ├── pages
│ ├── __init__.py
│ ├── page_index.py
│ └── page_login.py
│ ├── specs
│ ├── __init__.py
│ └── req_information.py
│ ├── test_info.py
│ └── utils.py
├── tests
├── api
│ ├── __init__.py
│ ├── suite_checkdevkey.py
│ ├── suite_tplan_by_name.py
│ ├── suite_tproject.py
│ ├── suite_tproject_tplans.py
│ └── suite_tprojects.py
└── web
│ ├── __init__.py
│ ├── suite_index.py
│ └── suite_login.py
└── tox.ini
/.circleci/config.yml:
--------------------------------------------------------------------------------
1 | # Python CircleCI 2.0 configuration file
2 | version: 2
3 | jobs:
4 | build:
5 | environment:
6 | CC_TEST_REPORTER_ID: 181a274c2c68483ff80af63a8a87e1f5fab71f37744eab702f25695501b5ca85
7 | docker:
8 | - image: circleci/python:3.6.1
9 |
10 | working_directory: ~/repo
11 |
12 | steps:
13 | - checkout
14 | - run:
15 | name: Install dependencies
16 | command: |
17 | # CI, CircleCI dependencies
18 | python3 -m venv venv
19 | . venv/bin/activate
20 | # CI, codeclimate dependencies
21 | curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
22 | chmod +x ./cc-test-reporter
23 | pip install codeclimate-test-reporter
24 | # project dependencies
25 | pip install coverage==4.2
26 | - run:
27 | name: Install project
28 | command: |
29 | . venv/bin/activate
30 | pip install qacode==0.6.2
31 | python setup.py install
32 | - run:
33 | name: Before Tests
34 | command: |
35 | ./cc-test-reporter before-build
36 | - run:
37 | name: Run Tests
38 | command: |
39 | . venv/bin/activate
40 | tox -e flake8,coverage
41 | - run:
42 | name: After Tests
43 | command: |
44 | . venv/bin/activate
45 | ls -ltra tests/reports/
46 | codeclimate-test-reporter --token $CC_TEST_REPORTER_ID --file .coverage
47 | - store_artifacts:
48 | path: dist
49 | destination: dist
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | *.egg-info/
24 | .installed.cfg
25 | *.egg
26 |
27 | # PyInstaller
28 | # Usually these files are written by a python script from a template
29 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
30 | *.manifest
31 | *.spec
32 |
33 | # Installer logs
34 | pip-log.txt
35 | pip-delete-this-directory.txt
36 |
37 | # Unit test / coverage reports
38 | htmlcov/
39 | .tox/
40 | .coverage
41 | .coverage.*
42 | .cache
43 | nosetests.xml
44 | coverage.xml
45 | *.cover
46 | .hypothesis/
47 |
48 | # Translations
49 | *.mo
50 | *.pot
51 |
52 | # Django stuff:
53 | *.log
54 | local_settings.py
55 |
56 | # Flask stuff:
57 | instance/
58 | .webassets-cache
59 |
60 | # Scrapy stuff:
61 | .scrapy
62 |
63 | # Sphinx documentation
64 | docs/_build/
65 |
66 | # PyBuilder
67 | target/
68 |
69 | # Jupyter Notebook
70 | .ipynb_checkpoints
71 |
72 | # pyenv
73 | .python-version
74 |
75 | # celery beat schedule file
76 | celerybeat-schedule
77 |
78 | # SageMath parsed files
79 | *.sage.py
80 |
81 | # Environments
82 | .env
83 | .venv
84 | env/
85 | venv/
86 | ENV/
87 |
88 | # Spyder project settings
89 | .spyderproject
90 | .spyproject
91 |
92 | # Rope project settings
93 | .ropeproject
94 |
95 | # mkdocs documentation
96 | /site
97 |
98 | # mypy
99 | .mypy_cache/
100 |
101 | # Sonar
102 | .sonar/
103 |
104 | # TESTLINKTESTS ignores
105 | tests/reports/*
106 | tests/reports/coverage/*
107 | tests/reports/benchmarks/benchmark.*.svg
108 | # Visual Studio
109 | .vs/
110 | # Visual code
111 | .vscode/
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | env:
2 | global:
3 | # GITHUB_TOKEN
4 | - secure: LYqe4kN1i8BqVEAO8fdO+CYrx9z8h1ab+NxCgYubLcP70DZoKNRj1/egULOd3uvDHFigFVeaACRR6vUQnHbHsffSkMr4nqwOeJMbxOdspHPuA4oMUy5RZKRC7P+v6Dlwpg4Psg/VsEnP6lHWb/RbosBE8tU8ukewD14EU3o29Ql+lBfvvOW/81UTGokMQa1zrW9o70oEaTYqePT9YzM9UcKgukshYtcxKE3oiwLm3fB8zBAUJwzkEvBGNpXjqBEDCUjrS80CqgY3BRsPfnPk90LgjeORaZKoP1f/bZE4UtgeESK0xpWsKEcDCRkSfGxYw8rD7nwc6H5LiCeoS87oQpUCMsoijmGL1yLrBBMIRAWoMC/o+h/QI5bb+IyLba6KLihY4LpExnWj2V8Mh6qs6AeV8v/Dl1WdyIi72WIkMBrmVrOhtoJJ45QaZJbrwSMeM4/ShS5NdiLFnGKeYOjMJ+DQZa+//SIwnvsOegm918TmOZqCr2YabI6WYixOzYjQPvI2KliZGekaX9uSNxVwoWZDE8jvdhvBWtHsL6hMqAv5ehEJw1aseLwjEGHQjIY0YBqJI38QmFr0vro6/9U2EehXHeW3ycCrPguQJ50nIK/DwiGMadUhrxU0xfZ6+TfFpGY0RivEPLD+Cup9C5oVFAppPJncdBdXUqouR90/8NI=
5 | addons:
6 | sonarqube:
7 | branches:
8 | - master
9 | language: python
10 | matrix:
11 | include:
12 | - os: linux
13 | sudo;: required
14 | python: 2.7
15 | env: TOXENV=py27
16 | - os: linux
17 | sudo;: required
18 | python: 3.4
19 | env: TOXENV=py34
20 | - os: linux
21 | sudo;: required
22 | python: 3.5
23 | env: TOXENV=py35
24 | - os: linux
25 | sudo;: required
26 | python: 3.6
27 | env: TOXENV=py36
28 |
29 | before_install:
30 | - pip freeze
31 | install:
32 | - pip install tox
33 | script:
34 | - tox -e "flake8,{$TOXENV}"
35 |
--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
1 | Testlink-tests
2 | ==============
3 |
4 |
5 | .. image:: https://img.shields.io/github/issues/TestLinkOpenSourceTRMS/testlink-tests.svg
6 | :alt: Issues on Github
7 | :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/issues
8 |
9 | .. image:: https://img.shields.io/github/issues-pr/TestLinkOpenSourceTRMS/testlink-tests.svg
10 | :alt: Pull Request opened on Github
11 | :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/issues
12 |
13 | .. image:: https://img.shields.io/github/release/TestLinkOpenSourceTRMS/testlink-tests.svg
14 | :alt: Release version on Github
15 | :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/releases/latest
16 |
17 | .. image:: https://img.shields.io/github/release-date/TestLinkOpenSourceTRMS/testlink-tests.svg
18 | :alt: Release date on Github
19 | :target: https://github.com/TestLinkOpenSourceTRMS/testlink-tests/releases/latest
20 |
21 |
22 | +-----------------------+-----------------------+--------------------------+--------------------------+------------------------------+
23 | | Branch | TravisCI | Appveyor | CircleCi - Docker | CodeClimate |
24 | +=======================+=======================+==========================+==========================+==============================+
25 | | master | |master_ci_travis| | |master_ci_appveyor| | |master_ci_circleci| | |master_ci_codeclimate| |
26 | +-----------------------+-----------------------+--------------------------+--------------------------+------------------------------+
27 |
28 |
29 | Python tested versions
30 | ----------------------
31 |
32 | +-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
33 | | **3.6** | **3.5** | **3.4** | **3.3** | **3.2** | **2.7** |
34 | +===================+===================+===================+===================+===================+===================+
35 | | *Supported* | *Supported* | *Supported* | *Not Supported* | *Not Supported* | *Supported* |
36 | +-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
37 |
38 |
39 | Prerequisites
40 | -------------
41 |
42 | + Need Testlink WebApp **Up and Running**
43 |
44 |
45 | How to install ?
46 | ----------------
47 |
48 | + Install from PIP : ``pip install testlinktests``
49 |
50 | + Install from setup.py file : ``python setup.py install``
51 |
52 |
53 |
54 | How to exec tests ?
55 | -------------------
56 |
57 | + Tests from setup.py file : ``python setup.py test``
58 |
59 | + Install from PIP file : ``pip install tox``
60 | + Tests from tox : ``tox -l && tox -e TOX_ENV_NAME`` ( *see tox.ini file to get environment names* )
61 |
62 |
63 | +---------------------+--------------------------------+
64 | | TOX Env name | Env description |
65 | +=====================+================================+
66 | | py27,py34,py35,py36 | Python supported versions |
67 | +---------------------+--------------------------------+
68 | | flake8 | Exec linter in qalab/ tests/ |
69 | +---------------------+--------------------------------+
70 | | coverage | Generate XML and HTML reports |
71 | +---------------------+--------------------------------+
72 |
73 | Configuration File
74 | ~~~~~~~~~~~~~~~~~~
75 |
76 |
77 | ::
78 |
79 | {
80 | "connection":{
81 | "is_https": false,
82 | "host": "qalab.tk",
83 | "port": 86
84 | },
85 | "dev_key": "1bfd2ef4ceda22b482b12f2b25457495",
86 | "log_level":"DEBUG",
87 | }
88 |
89 | Getting Started
90 | ~~~~~~~~~~~~~~~
91 |
92 | *Just starting example of usage before read* `Usage Guide`_.
93 |
94 |
95 | .. _Usage Guide: USAGE.rst
96 | .. |master_ci_travis| image:: https://travis-ci.com/TestLinkOpenSourceTRMS/testlink-tests.svg?branch=master
97 | :target: https://travis-ci.com/TestLinkOpenSourceTRMS/testlink-tests
98 | .. |master_ci_appveyor| image:: https://ci.appveyor.com/api/projects/status/5rcuh1wj3rissqu64wmb/branch/master?svg=true
99 | :target: https://ci.appveyor.com/project/netzulo/testlink-tests
100 | .. |master_ci_circleci| image:: https://circleci.com/gh/TestLinkOpenSourceTRMS/testlink-tests.svg?style=svg
101 | :target: https://circleci.com/gh/netzulo/testlink-tests)
102 | .. |master_ci_codeclimate| image:: https://api.codeclimate.com/v1/badges/-/maintainability
103 | :target: https://codeclimate.com/github/TestLinkOpenSourceTRMS/testlink-tests/maintainability
104 |
--------------------------------------------------------------------------------
/USAGE.rst:
--------------------------------------------------------------------------------
1 | Usage Guide
2 | ===========
3 |
4 | 1. Usage ( *WebAPP* )
5 | *********************
6 |
7 | + 1. Create JSON configuration ( runtime or read from file, *read config section* )
8 | + 2. Instance **Bot** object
9 |
10 | .. code:: python
11 |
12 |
13 | from qacode.core.bot import BotBase
14 | from qautils.files import settings
15 |
16 | cfg = settings(file_path="./testlink-tests/configs/")
17 | bot = BotBase(**cfg)
18 |
19 |
20 | + 3. Instance **Testlink Page** object
21 |
22 | .. code:: python
23 |
24 |
25 | from testlinktests.core.pages import (PageLogin, PageIndex)
26 |
27 | login = PageLogin(bot, **{"url": "http://netzulo.tk:88/login.php"})
28 | index = PageIndex(bot, **{"url": "http://netzulo.tk:88/index.php"})
29 |
30 | is_logged = login.login("admin", "admin")
31 | if not is_logged:
32 | raise Exception("Login not working")
33 | index.menu_top()
34 | index.menu_right()
35 | index.menu_left()
36 |
37 |
38 |
39 | 2. Usage ( *XMLRPC* )
40 | *********************
41 |
42 | + 1. Create JSON configuration ( runtime or read from file, *read config section* )
43 | + 2. Instance **testlink_manager** object ``testlink_manager = TLManager(settings=my_json_config)``
44 | + 3. Use some *method name with prefix* '**api_**'
45 |
46 | **api_login**
47 | +++++++++++++
48 |
49 | * **XMLRPC**: *call to method named* '*tl.checkDevKey*'
50 | * **Description** : check if dev_key it's valid
51 |
52 | **api_tprojects**
53 | +++++++++++++++++
54 |
55 | * **XMLRPC**: *call to method named* '*tl.getProjects*'
56 | * **Description** : get all test projects
57 |
58 |
59 | **api_tproject**
60 | ++++++++++++++++
61 |
62 | * **XMLRPC**: *call to method named* '*tl.getTestProjectByName*'
63 | * **Description** : get one test project filtered by name
64 |
65 | **api_tproject_tplans**
66 | +++++++++++++++++++++++
67 |
68 | * **XMLRPC**: *call to method named* '*tl.getProjectTestPlans*'
69 | * **Description** : get all test plans for one test project
70 |
71 | **api_tproject_tsuites_first_level**
72 | ++++++++++++++++++++++++++++++++++++
73 |
74 | * **XMLRPC**: *call to method named* '*tl.getFirstLevelTestSuitesForTestProject*'
75 | * **Description** : get all test suites on first level for one test project
76 |
77 | **api_tplan**
78 | +++++++++++++
79 |
80 | * **XMLRPC**: *call to method named* '*tl.getTestPlanByName*'
81 | * **Description** : get one test plan filtered by project and plan names
82 |
83 | **api_tplan_platforms**
84 | +++++++++++++++++++++++
85 |
86 | * **XMLRPC**: *call to method named* '*tl.getTestPlanPlatforms*'
87 | * **Description** : get one test plan filtered by project and plan names
88 |
89 | **api_tplan_builds**
90 | ++++++++++++++++++++
91 |
92 | * **XMLRPC**: *call to method named* '*tl.getBuildsForTestPlan*'
93 | * **Description** : get all builds for test project filtered by id
94 |
95 | **api_tplan_tsuites**
96 | +++++++++++++++++++++
97 |
98 | * **XMLRPC**: *call to method named* '*tl.getTestSuitesForTestPlan*'
99 | * **Description** : get all test suites assigned to test plan filtered by id
100 |
101 | **api_tplan_tcases**
102 | ++++++++++++++++++++
103 |
104 | * **XMLRPC**: *call to method named* '*tl.getTestCasesForTestPlan*'
105 | * **Description** : get all test cases assigned to test plan filtered by id
106 |
107 | **api_tplan_build_latest**
108 | ++++++++++++++++++++++++++
109 |
110 | * **XMLRPC**: *call to method named* '*tl.getLatestBuildForTestPlan*'
111 | * **Description** : get latest build by choosing the maximum build id for a specific test plan id
112 |
113 | **api_tplan_totals**
114 | ++++++++++++++++++++
115 |
116 | * **XMLRPC**: *call to method named* '*tl.getTotalsForTestPlan*'
117 | * **Description** : get totals for testplan filtered by id
118 |
119 | **api_tsuite**
120 | ++++++++++++++
121 |
122 | * **XMLRPC**: *call to method named* '*tl.getTestSuiteByID*'
123 | * **Description** : get test suite filtered by id
124 |
125 | **api_tsuite_tsuites**
126 | ++++++++++++++++++++++
127 |
128 | * **XMLRPC**: *call to method named* '*tl.getTestSuitesForTestSuite*'
129 | * **Description** : get test suites down of tree for one test suite filtered by id
130 |
131 | **api_tcase**
132 | +++++++++++++
133 |
134 | * **XMLRPC**: *call to method named* '*tl.getTestCase*'
135 | * **Description** : get test case filtered by id or external id
136 |
137 | **api_tcase_by_name**
138 | +++++++++++++++++++++
139 |
140 | * **XMLRPC**: *call to method named* '*tl.getTestCaseIDByName*'
141 | * **Description** : get test case filtered by name
142 |
143 | **api_tcase_report**
144 | ++++++++++++++++++++
145 |
146 | * **XMLRPC**: *call to method named* '*tl.reportTCResult*'
147 | * **Description** : reports a result for a single test case
148 |
149 | **api_user_exist**
150 | ++++++++++++++++++
151 |
152 | * **XMLRPC**: *call to method named* '*tl.doesUserExist*'
153 | * **Description** : check if user name it's valid
154 |
155 | **api_about**
156 | +++++++++++++
157 |
158 | * **XMLRPC**: *call to method named* '*tl.about*'
159 | * **Description** : get default message with author and testlink version
160 |
161 | **api_say_hello**
162 | +++++++++++++++++
163 |
164 | * **XMLRPC**: *call to method named* '*tl.sayHello*'
165 | * **Description** : get **'Hello!'** message
166 |
167 | **api_ping**
168 | ++++++++++++
169 |
170 | * **XMLRPC**: *call to method named* '*tl.ping*'
171 | * **Description** : get **'Hello!'** message
172 |
173 | **api_ping**
174 | ++++++++++++
175 |
176 | * **XMLRPC**: *call to method named* '*tl.repeat*'
177 | * **Description** : get **You said: 'your message here'** as message
178 |
--------------------------------------------------------------------------------
/appveyor.yml:
--------------------------------------------------------------------------------
1 | build: off
2 | branches:
3 | only:
4 | - master
5 | environment:
6 | global:
7 | # SDK v7.0 MSVC Express 2008's SetEnv.cmd script will fail if the
8 | # /E:ON and /V:ON options are not enabled in the batch script intepreter
9 | # See: http://stackoverflow.com/a/13751649/163740
10 | CMD_IN_ENV: "cmd /E:ON /V:ON /C .\\appveyor\\run_with_env.cmd"
11 | CLCACHE_NODIRECT: "true"
12 |
13 | matrix:
14 | - JOB: "2.7 32-bit"
15 | TOXENV: "py27"
16 | PYTHON: "C:\\Python27.10"
17 | PYTHON_VERSION: "2.7.10"
18 | PYTHON_ARCH: "32"
19 | - JOB: "2.7 64-bit"
20 | TOXENV: "py27"
21 | PYTHON: "C:\\Python27.10-x64"
22 | PYTHON_VERSION: "2.7.10"
23 | PYTHON_ARCH: "64"
24 |
25 | - JOB: "3.4 64-bit"
26 | TOXENV: "py34"
27 | PYTHON: "C:\\Python34-x64"
28 | PYTHON_VERSION: "3.4"
29 | PYTHON_ARCH: "64"
30 |
31 | - JOB: "3.5 64-bit"
32 | TOXENV: "py35"
33 | PYTHON: "C:\\Python35-x64"
34 | PYTHON_VERSION: "3.5.0"
35 | PYTHON_ARCH: "64"
36 |
37 | - JOB: "3.6 64-bit"
38 | TOXENV: "py36"
39 | PYTHON: "C:\\Python36"
40 | PYTHON_VERSION: "3.6.3"
41 | PYTHON_ARCH: "64"
42 |
43 | install:
44 | # Prepend newly installed Python to the PATH of this build (this cannot be
45 | # done from inside the powershell script as it would require to restart
46 | # the parent CMD process).
47 | - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
48 | # Check that we have the expected version and architecture for Python
49 | - "python --version"
50 | - "python -c \"import struct; print(struct.calcsize('P') * 8)\""
51 | # Upgrade to the latest version of pip to avoid it displaying warnings
52 | # about it being out of date.
53 | - "python -m pip install wheel"
54 | - "python -m pip install --pre -U tox"
55 |
56 | test_script:
57 | - "tox -e flake8,%TOXENV%"
58 |
59 | after_test:
60 | - "python setup.py sdist"
61 |
62 | artifacts:
63 | - path: "dist\\*"
64 |
--------------------------------------------------------------------------------
/logs/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/TestLinkOpenSourceTRMS/testlink-tests/af30ba3635ad9027ab8ea6de861f05f5cecbf335/logs/.gitkeep
--------------------------------------------------------------------------------
/pytest.ini:
--------------------------------------------------------------------------------
1 | [pytest]
2 | addopts = --verbose
3 | testpaths = tests
4 | console_output_style = progress
5 | python_files = suite_*.py
6 | python_classes = Test*
7 | python_functions = test_*
8 | filterwarnings =
9 | error
10 | ignore::UserWarning
--------------------------------------------------------------------------------
/rest-api/common/pest/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 |
--------------------------------------------------------------------------------
/rest-api/common/pest/Pest.php:
--------------------------------------------------------------------------------
1 | true, // return result instead of echoing
14 | CURLOPT_SSL_VERIFYPEER => false, // stop cURL from verifying the peer's certificate
15 | CURLOPT_FOLLOWLOCATION => false, // follow redirects, Location: headers
16 | CURLOPT_MAXREDIRS => 10, // but dont redirect more than 10 times
17 | CURLOPT_HTTPHEADER => array()
18 | );
19 |
20 | public $base_url;
21 |
22 | public $last_response;
23 | public $last_request;
24 | public $last_headers;
25 |
26 | public $throw_exceptions = true;
27 |
28 | public function __construct($base_url) {
29 | if (!function_exists('curl_init')) {
30 | throw new Exception('CURL module not available! Pest requires CURL. See http://php.net/manual/en/book.curl.php');
31 | }
32 |
33 | // only enable CURLOPT_FOLLOWLOCATION if safe_mode and open_base_dir are not in use
34 | if(ini_get('open_basedir') == '' && strtolower(ini_get('safe_mode')) == 'off') {
35 | $this->curl_opts['CURLOPT_FOLLOWLOCATION'] = true;
36 | }
37 |
38 | $this->base_url = $base_url;
39 |
40 | // The callback to handle return headers
41 | // Using PHP 5.2, it cannot be initialised in the static context
42 | $this->curl_opts[CURLOPT_HEADERFUNCTION] = array($this, 'handle_header');
43 | }
44 |
45 | // $auth can be 'basic' or 'digest'
46 | public function setupAuth($user, $pass, $auth = 'basic') {
47 | $this->curl_opts[CURLOPT_HTTPAUTH] = constant('CURLAUTH_'.strtoupper($auth));
48 | $this->curl_opts[CURLOPT_USERPWD] = $user . ":" . $pass;
49 | }
50 |
51 | // Enable a proxy
52 | public function setupProxy($host, $port, $user = NULL, $pass = NULL) {
53 | $this->curl_opts[CURLOPT_PROXYTYPE] = 'HTTP';
54 | $this->curl_opts[CURLOPT_PROXY] = $host;
55 | $this->curl_opts[CURLOPT_PROXYPORT] = $port;
56 | if ($user && $pass) {
57 | $this->curl_opts[CURLOPT_PROXYUSERPWD] = $user . ":" . $pass;
58 | }
59 | }
60 |
61 | public function get($url, $data=array()) {
62 | if (!empty($data)) {
63 | $pos = strpos($url, '?');
64 | if ($pos !== false) {
65 | $url = substr($url, 0, $pos);
66 | }
67 | $url .= '?' . http_build_query($data);
68 | }
69 |
70 | $curl = $this->prepRequest($this->curl_opts, $url);
71 | $body = $this->doRequest($curl);
72 |
73 | $body = $this->processBody($body);
74 |
75 | return $body;
76 | }
77 |
78 | public function head($url) {
79 | $curl_opts = $this->curl_opts;
80 | $curl_opts[CURLOPT_NOBODY] = true;
81 |
82 | $curl = $this->prepRequest($this->curl_opts, $url);
83 | $body = $this->doRequest($curl);
84 |
85 | $body = $this->processBody($body);
86 |
87 | return $body;
88 | }
89 |
90 | public function prepData($data) {
91 | if (is_array($data)) {
92 | $multipart = false;
93 |
94 | foreach ($data as $item) {
95 | if (is_string($item) && strncmp($item, "@", 1) == 0 && is_file(substr($item, 1))) {
96 | $multipart = true;
97 | break;
98 | }
99 | }
100 |
101 | return ($multipart) ? $data : http_build_query($data);
102 | } else {
103 | return $data;
104 | }
105 | }
106 |
107 | public function post($url, $data, $headers=array()) {
108 | $data = $this->prepData($data);
109 |
110 | $curl_opts = $this->curl_opts;
111 | $curl_opts[CURLOPT_CUSTOMREQUEST] = 'POST';
112 | if (!is_array($data)) $headers[] = 'Content-Length: '.strlen($data);
113 | $curl_opts[CURLOPT_HTTPHEADER] = array_merge($headers,$curl_opts[CURLOPT_HTTPHEADER]);
114 | $curl_opts[CURLOPT_POSTFIELDS] = $data;
115 |
116 | $curl = $this->prepRequest($curl_opts, $url);
117 | $body = $this->doRequest($curl);
118 |
119 | $body = $this->processBody($body);
120 |
121 | return $body;
122 | }
123 |
124 | public function put($url, $data, $headers=array()) {
125 | $data = $this->prepData($data);
126 |
127 | $curl_opts = $this->curl_opts;
128 | $curl_opts[CURLOPT_CUSTOMREQUEST] = 'PUT';
129 | if (!is_array($data)) $headers[] = 'Content-Length: '.strlen($data);
130 | $curl_opts[CURLOPT_HTTPHEADER] = $headers;
131 | $curl_opts[CURLOPT_POSTFIELDS] = $data;
132 |
133 | $curl = $this->prepRequest($curl_opts, $url);
134 | $body = $this->doRequest($curl);
135 |
136 | $body = $this->processBody($body);
137 |
138 | return $body;
139 | }
140 |
141 | public function patch($url, $data, $headers=array()) {
142 | $data = (is_array($data)) ? http_build_query($data) : $data;
143 |
144 | $curl_opts = $this->curl_opts;
145 | $curl_opts[CURLOPT_CUSTOMREQUEST] = 'PATCH';
146 | $headers[] = 'Content-Length: '.strlen($data);
147 | $curl_opts[CURLOPT_HTTPHEADER] = $headers;
148 | $curl_opts[CURLOPT_POSTFIELDS] = $data;
149 |
150 | $curl = $this->prepRequest($curl_opts, $url);
151 | $body = $this->doRequest($curl);
152 |
153 | $body = $this->processBody($body);
154 |
155 | return $body;
156 | }
157 |
158 | public function delete($url) {
159 | $curl_opts = $this->curl_opts;
160 | $curl_opts[CURLOPT_CUSTOMREQUEST] = 'DELETE';
161 |
162 | $curl = $this->prepRequest($curl_opts, $url);
163 | $body = $this->doRequest($curl);
164 |
165 | $body = $this->processBody($body);
166 |
167 | return $body;
168 | }
169 |
170 | public function lastBody() {
171 | return $this->last_response['body'];
172 | }
173 |
174 | public function lastStatus() {
175 | return $this->last_response['meta']['http_code'];
176 | }
177 |
178 | /**
179 | * Return the last response header (case insensitive) or NULL if not present.
180 | * HTTP allows empty headers (e.g. RFC 2616, Section 14.23), thus is_null()
181 | * and not negation or empty() should be used.
182 | */
183 | public function lastHeader($header) {
184 | if (empty($this->last_headers[strtolower($header)])) {
185 | return NULL;
186 | }
187 | return $this->last_headers[strtolower($header)];
188 | }
189 |
190 | protected function processBody($body) {
191 | // Override this in classes that extend Pest.
192 | // The body of every GET/POST/PUT/DELETE response goes through
193 | // here prior to being returned.
194 | return $body;
195 | }
196 |
197 | protected function processError($body) {
198 | // Override this in classes that extend Pest.
199 | // The body of every erroneous (non-2xx/3xx) GET/POST/PUT/DELETE
200 | // response goes through here prior to being used as the 'message'
201 | // of the resulting Pest_Exception
202 | return $body;
203 | }
204 |
205 |
206 | protected function prepRequest($opts, $url) {
207 | if (strncmp($url, $this->base_url, strlen($this->base_url)) != 0) {
208 | $url = rtrim($this->base_url, '/') . '/' . ltrim($url, '/');
209 | }
210 | $curl = curl_init($url);
211 |
212 | foreach ($opts as $opt => $val)
213 | curl_setopt($curl, $opt, $val);
214 |
215 | $this->last_request = array(
216 | 'url' => $url
217 | );
218 |
219 | if (isset($opts[CURLOPT_CUSTOMREQUEST]))
220 | $this->last_request['method'] = $opts[CURLOPT_CUSTOMREQUEST];
221 | else
222 | $this->last_request['method'] = 'GET';
223 |
224 | if (isset($opts[CURLOPT_POSTFIELDS]))
225 | $this->last_request['data'] = $opts[CURLOPT_POSTFIELDS];
226 |
227 | return $curl;
228 | }
229 |
230 | private function handle_header($ch, $str) {
231 | if (preg_match('/([^:]+):\s(.+)/m', $str, $match) ) {
232 | $this->last_headers[strtolower($match[1])] = trim($match[2]);
233 | }
234 | return strlen($str);
235 | }
236 |
237 | private function doRequest($curl) {
238 | $this->last_headers = array();
239 |
240 | $body = curl_exec($curl);
241 | $meta = curl_getinfo($curl);
242 |
243 | $this->last_response = array(
244 | 'body' => $body,
245 | 'meta' => $meta
246 | );
247 |
248 | curl_close($curl);
249 |
250 | $this->checkLastResponseForError();
251 |
252 | return $body;
253 | }
254 |
255 | protected function checkLastResponseForError() {
256 | if ( !$this->throw_exceptions)
257 | return;
258 |
259 | $meta = $this->last_response['meta'];
260 | $body = $this->last_response['body'];
261 |
262 | if (!$meta)
263 | return;
264 |
265 | $err = null;
266 | switch ($meta['http_code']) {
267 | case 400:
268 | throw new Pest_BadRequest($this->processError($body));
269 | break;
270 | case 401:
271 | throw new Pest_Unauthorized($this->processError($body));
272 | break;
273 | case 403:
274 | throw new Pest_Forbidden($this->processError($body));
275 | break;
276 | case 404:
277 | throw new Pest_NotFound($this->processError($body));
278 | break;
279 | case 405:
280 | throw new Pest_MethodNotAllowed($this->processError($body));
281 | break;
282 | case 409:
283 | throw new Pest_Conflict($this->processError($body));
284 | break;
285 | case 410:
286 | throw new Pest_Gone($this->processError($body));
287 | break;
288 | case 422:
289 | // Unprocessable Entity -- see http://www.iana.org/assignments/http-status-codes
290 | // This is now commonly used (in Rails, at least) to indicate
291 | // a response to a request that is syntactically correct,
292 | // but semantically invalid (for example, when trying to
293 | // create a resource with some required fields missing)
294 | throw new Pest_InvalidRecord($this->processError($body));
295 | break;
296 | default:
297 | if ($meta['http_code'] >= 400 && $meta['http_code'] <= 499)
298 | throw new Pest_ClientError($this->processError($body));
299 | elseif ($meta['http_code'] >= 500 && $meta['http_code'] <= 599)
300 | throw new Pest_ServerError($this->processError($body));
301 | elseif (!$meta['http_code'] || $meta['http_code'] >= 600) {
302 | throw new Pest_UnknownResponse($this->processError($body));
303 | }
304 | }
305 | }
306 | }
307 |
308 |
309 | class Pest_Exception extends Exception { }
310 | class Pest_UnknownResponse extends Pest_Exception { }
311 |
312 | /* 401-499 */ class Pest_ClientError extends Pest_Exception {}
313 | /* 400 */ class Pest_BadRequest extends Pest_ClientError {}
314 | /* 401 */ class Pest_Unauthorized extends Pest_ClientError {}
315 | /* 403 */ class Pest_Forbidden extends Pest_ClientError {}
316 | /* 404 */ class Pest_NotFound extends Pest_ClientError {}
317 | /* 405 */ class Pest_MethodNotAllowed extends Pest_ClientError {}
318 | /* 409 */ class Pest_Conflict extends Pest_ClientError {}
319 | /* 410 */ class Pest_Gone extends Pest_ClientError {}
320 | /* 422 */ class Pest_InvalidRecord extends Pest_ClientError {}
321 |
322 | /* 500-599 */ class Pest_ServerError extends Pest_Exception {}
323 |
324 | ?>
325 |
--------------------------------------------------------------------------------
/rest-api/common/pest/PestJSON.php:
--------------------------------------------------------------------------------
1 | = 400 status codes, an exception is thrown with $e->getMessage()
16 | * containing the error message that the server produced. User code will have to
17 | * json_decode() that manually, if applicable, because the PHP Exception base
18 | * class does not accept arrays for the exception message and some JSON/REST servers
19 | * do not produce nice JSON
20 | *
21 | * See http://github.com/educoder/pest for details.
22 | *
23 | * This code is licensed for use, modification, and distribution
24 | * under the terms of the MIT License (see http://en.wikipedia.org/wiki/MIT_License)
25 | */
26 | class PestJSON extends Pest
27 | {
28 | public function post($url, $data, $headers=array()) {
29 | return parent::post($url, json_encode($data), $headers);
30 | }
31 |
32 | public function put($url, $data, $headers=array()) {
33 | return parent::put($url, json_encode($data), $headers);
34 | }
35 |
36 | protected function prepRequest($opts, $url) {
37 | $opts[CURLOPT_HTTPHEADER][] = 'Accept: application/json';
38 | $opts[CURLOPT_HTTPHEADER][] = 'Content-Type: application/json';
39 | return parent::prepRequest($opts, $url);
40 | }
41 |
42 | public function processBody($body) {
43 | return json_decode($body, true);
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/rest-api/common/pest/PestXML.php:
--------------------------------------------------------------------------------
1 | tag in the response is assumed to be the error mssage)
16 | *
17 | * See http://github.com/educoder/pest for details.
18 | *
19 | * This code is licensed for use, modification, and distribution
20 | * under the terms of the MIT License (see http://en.wikipedia.org/wiki/MIT_License)
21 | */
22 | class PestXML extends Pest {
23 | public function processBody($body) {
24 | libxml_use_internal_errors(true);
25 | if (empty($body) || preg_match('/^\s+$/', $body))
26 | return null;
27 |
28 | $xml = simplexml_load_string($body);
29 |
30 | if (!$xml) {
31 | $err = "Couldn't parse XML response because:\n";
32 | $xml_errors = libxml_get_errors();
33 | libxml_clear_errors();
34 | if(!empty($xml_errors))
35 | {
36 | foreach($xml_errors as $xml_err)
37 | $err .= "\n - " . $xml_err->message;
38 | $err .= "\nThe response was:\n";
39 | $err .= $body;
40 | throw new PestXML_Exception($err);
41 | }
42 | }
43 |
44 | return $xml;
45 | }
46 |
47 | public function processError($body) {
48 | try {
49 | $xml = $this->processBody($body);
50 | if (!$xml)
51 | return $body;
52 |
53 | $error = $xml->xpath('//error');
54 |
55 | if ($error && $error[0])
56 | return strval($error[0]);
57 | else
58 | return $body;
59 | } catch (PestXML_Exception $e) {
60 | return $body;
61 | }
62 | }
63 | }
64 |
65 | class PestXML_Exception extends Pest_Exception { }
66 |
67 | ?>
--------------------------------------------------------------------------------
/rest-api/common/pest/README.markdown:
--------------------------------------------------------------------------------
1 | Pest
2 | ====
3 |
4 | **Pest** is a PHP client library for [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer)
5 | web services.
6 |
7 | Unlike [Zend_Rest_Client](http://framework.zend.com/manual/en/zend.rest.client.html), which is not
8 | really a "REST" client at all (more like RPC-over-HTTP), Pest supports the four REST verbs
9 | (GET/POST/PUT/DELETE) and pays attention to HTTP response status codes.
10 |
11 |
12 | Basic Example
13 | -------------
14 |
15 | Pest's get/post/put/delete() return the raw response body as a string.
16 | See the info on PestXML (below) if you're working with XML-based REST services and
17 | PestJSON if you're working with JSON.
18 |
19 | get('/things');
25 |
26 | $thing = $pest->post('/things',
27 | array(
28 | 'name' => "Foo",
29 | 'colour' => "Red"
30 | )
31 | );
32 |
33 | $thing = $pest->put('/things/15',
34 | array(
35 | 'colour' => "Blue"
36 | )
37 | );
38 |
39 | $pest->delete('/things/15');
40 |
41 | ?>
42 |
43 | Responses with error status codes (4xx and 5xx) raise exceptions.
44 |
45 | get('/things/18');
49 | } catch (Pest_NotFound $e) {
50 | // 404
51 | echo "Thing with ID 18 doesn't exist!";
52 | }
53 |
54 | try {
55 | $thing = $pest->post('/things', array('colour' => "Red"));
56 | } catch (Pest_InvalidRecord $e) {
57 | // 422
58 | echo "Data for Thing is invalid because: ".$e->getMessage();
59 | }
60 |
61 | ?>
62 |
63 | PestXML
64 | -------
65 |
66 | **PestXML** is an XML-centric version of Pest, specifically targeted at REST services that
67 | return XML data. Rather than returning the raw response body as a string, PestXML will
68 | try to parse the service's response into a [SimpleXML](http://php.net/manual/en/book.simplexml.php) object.
69 |
70 | get('/things.xml');
76 |
77 | $colours = $things->xpath('//colour');
78 | foreach($colours as $colour) {
79 | echo $colour."\n";
80 | }
81 |
82 | ?>
83 |
84 | Similarly, **PestJSON** is a JSON-centric version of Pest.
85 |
86 | Much more detailed examples are available in the `examples` directory:
87 |
88 | * [Rollcall Example](http://github.com/educoder/pest/blob/master/examples/rollcall_example.php)
89 | * [OpenStreetMap Example](http://github.com/educoder/pest/blob/master/examples/open_street_map_example.php)
90 |
91 |
92 | TODO
93 | ----
94 |
95 | * Authentication
96 | * Follow Redirects
97 |
98 |
99 | License
100 | -------
101 |
102 | Copyright (C) 2011 by University of Toronto
103 |
104 | Permission is hereby granted, free of charge, to any person obtaining a copy
105 | of this software and associated documentation files (the "Software"), to deal
106 | in the Software without restriction, including without limitation the rights
107 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
108 | copies of the Software, and to permit persons to whom the Software is
109 | furnished to do so, subject to the following conditions:
110 |
111 | The above copyright notice and this permission notice shall be included in
112 | all copies or substantial portions of the Software.
113 |
114 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
115 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
116 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
117 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
118 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
119 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
120 | THE SOFTWARE.
--------------------------------------------------------------------------------
/rest-api/common/pest/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "educoder/pest",
3 | "description": "A proper REST client for PHP.",
4 | "require": {
5 |
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/rest-api/common/pest/examples/intouch_example.php:
--------------------------------------------------------------------------------
1 | setupAuth($user ."@". $logindomain, $password);
25 | $pest->curl_opts[CURLOPT_FOLLOWLOCATION] = false; // Not supported on hosts running safe_mode!
26 |
27 |
28 | echo "1. Creating a contact in the address book
";
29 | try
30 | {
31 | $contactdata = array(
32 | 'Firstname' => $firstname,
33 | 'Lastname' => $lastname,
34 | 'PhoneNumber' => $phonenumber
35 | );
36 |
37 | $contactjson = $pest->post('/contacts', $contactdata);
38 | $contactarray = json_decode($contactjson,true);
39 | $contactId = $contactarray[ContactId];
40 | echo "
Created contact with id: " . $contactId;
41 | }
42 | catch (Exception $e)
43 | {
44 | echo "
Caught exception when creating contact : " . $e->getMessage() . "
";
45 | }
46 |
47 |
48 | echo "2. Getting the contact by its phonenumber and updating it.
";
49 | try
50 | {
51 | $contactjson = $pest->get('/contacts/phonenumber/' . $phonenumber);
52 | $contactarray = json_decode($contactjson,true);
53 | echo "
Retrieved contact with id: " . $contactarray[ContactId] . ", should be identical with " . $contactId . " from part 1.
";
54 |
55 | $contactarray[Description] = $description;
56 | $contactjson = json_encode($contactarray);
57 |
58 | $pest->put('/contacts/' . $contactarray[ContactId], $contactjson);
59 | echo "
Updated contact
";
60 | }
61 | catch (Exception $e)
62 | {
63 | echo "
Caught exception when retrieving or updating contact : " . $e->getMessage() . "
";
64 | }
65 |
66 |
67 | echo "3. Sending a message to the contact
";
68 | try
69 | {
70 | $messagedata = array(
71 | 'Receivers' => "/contacts/" . $contactId,
72 | 'SenderNumber' => $sendernumber,
73 | 'Text' => $messagetext
74 | );
75 |
76 | $messagejson = $pest->post('/messages', $messagedata);
77 | $messagearray = json_decode($messagejson,true);
78 | echo "
Message was sent! MessageId: " . $messagearray[MessageId];
79 | }
80 | catch (Exception $e)
81 | {
82 | echo "
Caught exception when sending message : " . $e->getMessage() . "
";
83 | }
84 |
85 |
86 | echo "4. Deleting contact.
";
87 | try
88 | {
89 | $pest->delete('/contacts/' . $contactId);
90 | echo "
Deleted contact.
";
91 | }
92 | catch (Exception $e)
93 | {
94 | echo "
Caught exception when deleting contact : " . $e->getMessage() . "
";
95 | }
96 | ?>
--------------------------------------------------------------------------------
/rest-api/common/pest/examples/open_street_map_example.php:
--------------------------------------------------------------------------------
1 | get('/map?bbox=-79.39997,43.65827,-79.39344,43.66903');
14 |
15 | // Print all of the street names in the map
16 | $streets = $map->xpath('//way/tag[@k="name"]');
17 | foreach ($streets as $s) {
18 | echo $s['v'] . "\n";
19 | }
20 |
21 | ?>
--------------------------------------------------------------------------------
/rest-api/common/pest/examples/rollcall_example.php:
--------------------------------------------------------------------------------
1 | get('/users.xml');
14 |
15 | foreach($users->user as $user) {
16 | echo $user->{'display-name'}." (".$user->username.")\n";
17 | }
18 | echo "\n";
19 |
20 | // Create a new User
21 | $data = array(
22 | 'user' => array(
23 | 'username' => "jcricket",
24 | 'password' => "pinocchio",
25 | 'display_name' => "Jiminy Cricket",
26 | 'kind' => "Student"
27 | )
28 | );
29 |
30 | $user = $pest->post('/users.xml', $data);
31 |
32 | echo "New User's ID: ".$user->id."\n";
33 | echo "\n";
34 |
35 |
36 | // Update the newly created User's attributes
37 | $data = array(
38 | 'user' => array(
39 | 'kind' => "Instructor",
40 | 'metadata' => array(
41 | 'gender' => 'male',
42 | 'age' => 30
43 | )
44 | )
45 | );
46 |
47 | $pest->put('/users/'.$user->id.'.xml', $data);
48 |
49 |
50 | // Retrieve the User
51 | $user = $pest->get('/users/'.$user->id.'.xml');
52 | echo "User XML: \n";
53 | echo $user->asXML();
54 | echo "\n";
55 | echo "Name: ".$user->{'display-name'}."\n";
56 | echo "Kind: ".$user->kind."\n";
57 | echo "Age: ".$user->metadata->age."\n";
58 | echo "\n";
59 |
60 | // Delete the User
61 | $user = $pest->delete('/users/'.$user->id.'.xml');
62 |
63 |
64 | // Try to create a User with invalid data (missing username)
65 | $data = array(
66 | 'user' => array(
67 | 'password' => "pinocchio",
68 | 'display_name' => "Jiminy Cricket",
69 | 'kind' => "Student"
70 | )
71 | );
72 |
73 | try {
74 | $user = $pest->post('/users.xml', $data);
75 | } catch (Pest_InvalidRecord $e) {
76 | echo $e->getMessage();
77 | echo "\n";
78 | }
79 |
80 | ?>
--------------------------------------------------------------------------------
/rest-api/v1/curl/execution/createTestCaseExecution.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - PUT /executions'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/createTestCaseExecution.json" \
14 | -u dev02:thisisnoytmypassword http://localhost/development/tlrepo/lib/api/rest/v1/executions
--------------------------------------------------------------------------------
/rest-api/v1/curl/generic/createTestCaseX.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | clear
13 | echo 'Testing TestLink REST API - POST /testcases'
14 | echo
15 | if [ -z "$1" ]; then
16 | echo usage: $0 .JSONFILE \(searched in ../json/\)
17 | exit
18 | fi
19 |
20 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/$1" \
21 | -u restadminapikey:followthewitherabbitneo \
22 | http://localhost/development/tlrepo/lib/api/rest/v1/testcases
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/README:
--------------------------------------------------------------------------------
1 | Files present on this directory can be used to test TestLink REST API using curl
2 |
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCase.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case ALFA",
3 | "testSuiteID":360,
4 | "testProjectID":358,
5 | "summary":"This is a summary for Test Case",
6 | "preconditions":"No preconditions",
7 | "order":100,
8 | "authorID":1,
9 | "importance":2,
10 | "executionType":1
11 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCaseB.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case ALFA",
3 | "testSuiteID":360,
4 | "testProjectID":358,
5 | "summary":"This is a summary for Test Case",
6 | "preconditions":"No preconditions",
7 | "order":100,
8 | "authorID":1,
9 | "importance":2,
10 | "executionType":1
11 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCaseExecution.json:
--------------------------------------------------------------------------------
1 | {
2 | "testPlanID":1195,
3 | "buildID":22,
4 | "platformID":28,
5 | "testCaseExternalID":"PON-3",
6 | "notes":"This is an execution created via REST API",
7 | "statusCode":"b",
8 | "executionType":"1",
9 | "executionTimeStampISO":"2013-04-27 12:09:00"
10 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCaseWithSteps.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case BETA has STEPS",
3 | "testSuiteID":378,
4 | "testProject":{"id":358},
5 | "summary":"This is a summary for Test Case",
6 | "preconditions":"No preconditions",
7 | "order":100,
8 | "authorID":1,
9 | "importance":2,
10 | "executionType":1,
11 | "steps": [
12 | { "step_number":1,
13 | "actions": "red",
14 | "expected_results": "#f00",
15 | "execution_type":1
16 | },
17 | { "step_number":12,
18 | "actions": "red12",
19 | "expected_results": "#f00",
20 | "execution_type":2
21 | }
22 | ]
23 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCaseXL5.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case XL5-A",
3 | "testSuiteID":378,
4 | "testProjectID": 358,
5 | "summary": "This is a summary for Test Case second line line #3",
6 | "preconditions":"No preconditions",
7 | "order":100,
8 | "authorID":1,
9 | "importance":2,
10 | "executionType":1
11 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCaseXL5B.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case XL5-B",
3 | "testSuiteID":378,"testProjectID":358,
4 | "summary":
5 | "This is a summary for Test Case
6 | second line
7 | line #3",
8 | "preconditions":"No preconditions",
9 | "order":100,"authorID":1,"importance":2,"executionType":1
10 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCaseXL5C.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case XL5-C",
3 | "testSuiteID":378,"testProjectID":358,
4 | "summary":
5 | "This is a summary for Test Case
6 | second line
7 | line #3",
8 | "preconditions":"No preconditions",
9 | "order":100,"authorID":1,"importance":2,"executionType":1
10 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestCaseXL5D.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case XL5-D",
3 | "testSuiteID":378,"testProjectID":358,
4 | "summary":
5 | "This is a summary for Test Case
6 | second line
7 | line #3",
8 | "preconditions":"No preconditions for this testcase.
9 |
If you use an array [] can be empty
10 |
If you need to use a object {}",
11 | "order":100,"authorID":1,"importance":2,"executionType":1
12 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestPlan.json:
--------------------------------------------------------------------------------
1 | {"name":"TestPlan Frenchitas",
2 | "testProjectID":358,
3 | "notes":"This is a FrenchToJD",
4 | "active":1,"is_public":1
5 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestProject.json:
--------------------------------------------------------------------------------
1 | {"name":"FrenchToJD(month, day, year)",
2 | "notes":"This is a FrenchToJD",
3 | "color":"",
4 | "prefix":"FTJD",
5 | "active":1,
6 | "is_public":1,
7 | "options":{"requirementsEnabled":0,"testPriorityEnabled":1,
8 | "automationEnabled":1,"inventoryEnabled":0}
9 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/createTestSuite.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"TestSuite TS100-B",
3 | "testProjectID":358,
4 | "parentID":358,
5 | "notes":"This is my first TS via REST",
6 | "order":100
7 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/setTestPlanActive.json:
--------------------------------------------------------------------------------
1 | {"active":1}
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/setTestPlanInactive.json:
--------------------------------------------------------------------------------
1 | {"active":0}
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/setTestPlanNotes.json:
--------------------------------------------------------------------------------
1 | {"notes":"What's up doc"}
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/setTestPlanPrivate.json:
--------------------------------------------------------------------------------
1 | {"is_public":0}
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/testCaseComplex.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Scenarios for Filter Criteria",
3 | "testSuiteID":378,"testProjectID":358,
4 | "preconditions":"No preconditions for this testcase.
5 |
If you use an array [] can be empty
6 |
If you need to use a object {}",
7 | "order":100,"authorID":1,"importance":2,"executionType":1,
8 | "summary":
9 | "
1. User should be able to filter results using all parameters on the page
10 |
2. Refine search functionality should load search page with all user selected search parameters
11 |
3. When there is at least one filter criteria is required to perform search operation,
12 |
make sure proper error message is displayed when user submits the page without selecting any filter criteria.
13 |
4. When at least one filter criteria selection is not compulsory user
14 |
should be able to submit page and default search criteria should get used to query results
15 |
5. Proper validation messages should be displayed for invalid values for filter criteria"
16 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/json/testCaseComplex2.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Scenarios for a Window",
3 | "testSuiteID":378,"testProjectID":358,
4 | "preconditions":"No preconditions for this testcase.
5 |
If you use an array [] can be empty
6 |
If you need to use a object {}",
7 | "order":100,"authorID":1,"importance":2,"executionType":1,
8 | "summary":
9 | "
1. Check if default window size is correct
10 |
2. Check if child window size is correct
11 |
3. Check if there is any field on page with default focus (in general, the focus should be set on first input field of the screen)
12 |
4. Check if child windows are getting closed on closing parent/opener window
13 |
5. If child window is opened, user should not be able to use or update any field on background or parent window
14 |
6. Check window minimize, maximize and close functionality
15 |
7. Check if window is re-sizable
16 |
8. Check scroll bar functionality for parent and child windows
17 |
9. Check cancel button functionality for child window"
18 | }
--------------------------------------------------------------------------------
/rest-api/v1/curl/testplan/createTestPlan.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testplans'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/createTestPlan.json" \
14 | -u restadminapikey:thebrownfox http://localhost/development/tlrepo/lib/api/rest/v1/testplans
--------------------------------------------------------------------------------
/rest-api/v1/curl/testplan/setTestPlanActive.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testplans'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/setTestPlanActive.json" \
14 | -u restadminapikey:thebrownfox http://localhost/development/tlrepo/lib/api/rest/v1/testplans/359
--------------------------------------------------------------------------------
/rest-api/v1/curl/testplan/setTestPlanInactive.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testplans'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/setTestPlanInactive.json" \
14 | -u restadminapikey:thebrownfox http://localhost/development/tlrepo/lib/api/rest/v1/testplans/359
--------------------------------------------------------------------------------
/rest-api/v1/curl/testplan/setTestPlanNotes.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testplans'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/setTestPlanNotes.json" \
14 | -u restadminapikey:thebrownfox http://localhost/development/tlrepo/lib/api/rest/v1/testplans/359
--------------------------------------------------------------------------------
/rest-api/v1/curl/testplan/setTestPlanPrivate.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testplans'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/setTestPlanPrivate.json" \
14 | -u restadminapikey:thebrownfox http://localhost/development/tlrepo/lib/api/rest/v1/testplans/359
--------------------------------------------------------------------------------
/rest-api/v1/curl/testplan/updateTestPlan.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testplans'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/setTestPlanInactive.json" \
14 | -u restadminapikey:thebrownfox http://localhost/development/tlrepo/lib/api/rest/v1/testplans/359
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/createTestCase.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testcases'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/createTestCase.json" \
14 | -u restadminapikey:followthewitherabbitneo \
15 | http://localhost/development/tlrepo/lib/api/rest/v1/testcases
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/createTestCaseWithSteps.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testcases'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/createTestCaseWithSteps.json" \
14 | -u restadminapikey:followthewitherabbitneo \
15 | http://localhost/development/tlrepo/lib/api/rest/v1/testcases
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/createTestProject.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testprojects'
13 | TURL="http://localhost/development/github/testlink-code";
14 | TURL="$TURL/lib/api/rest/v2/testprojects"
15 | # AUTH="restapi-leader:dev01"
16 | AUTH="restapi-admin:fruta"
17 |
18 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/createTestProject.json" -u $AUTH $TURL
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/createTestSuite.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - POST /testsuites'
13 | curl -i -H "Content-Type: application/json" -X POST --data "@../json/createTestSuite.json" \
14 | -u restadminapikey:followthewitherabbitneo \
15 | http://localhost/development/tlrepo/lib/api/rest/v1/testsuites
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/getAllTestProjects.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - GET /testprojects'
13 | curl -i -X GET -u dev01xxx:dev01 http://localhost/development/test_tl/testlink/lib/api/rest/v1/testprojects
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/getOneTestProjectByID.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - GET /testprojects/374'
13 | curl -i -X GET -u 524993143f974f97903f5565a783594b:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects/374
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/getOneTestProjectByName.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | clear
13 | echo '*****************************************************************'
14 | echo 'Testing TestLink REST API - GET /testprojects/Slim+REST+Framework'
15 | echo ''
16 | echo 'We have added + to escape BLANK IN Test Project Name'
17 | echo '*****************************************************************'
18 | echo ''
19 | echo ''
20 | curl -i -X GET -u 524993143f974f97903f5565a783594b:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects/Slim+REST+Framework
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/getTestCasesInTestProject.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - GET /testprojects/94/testcases'
13 | curl -i -X GET -u admin:noway http://localhost/development/test_tl/testlink/lib/api/rest/v1/testprojects/94/testcases
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/getTestCasesInTestProjectByTestProjectName.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - GET /testprojects/94/testcases'
13 | curl -i -X GET -u admin:noway http://localhost/development/test_tl/testlink/lib/api/rest/v1/testprojects/FLOWER/testcases
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/getTestPlansInTestProject.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - GET /testprojects/94/testplans'
13 | curl -i -X GET -u admin:noway http://localhost/development/test_tl/testlink/lib/api/rest/v1/testprojects/94/testplans
--------------------------------------------------------------------------------
/rest-api/v1/curl/testproject/getTestPlansInTestProjectByTestProjectName.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | echo 'Testing TestLink REST API - GET /testprojects/94/testplans'
13 | curl -i -X GET -u admin:noway http://localhost/development/test_tl/testlink/lib/api/rest/v1/testprojects/FLOWER/testplans
--------------------------------------------------------------------------------
/rest-api/v1/php/execution/createTestCaseExecution.php:
--------------------------------------------------------------------------------
1 | getBody()
11 | * I've got always null.
12 | * Seems that POST BODY is not created.
13 | *
14 | * Changing to PestJSON.php, did the trick
15 | *
16 | */
17 |
18 | require '../../../common/pest/PestJSON.php';
19 |
20 | if(!isset($_REQUEST['env']))
21 | {
22 | die('env not provided: valid options: bit,gito - call URL?env=');
23 | }
24 |
25 | if($_REQUEST['env'] == 'bit')
26 | {
27 | $pest = new PestJSON('http://localhost/development/bitbucket/testlink/lib/api/rest/v1/');
28 | }
29 |
30 | if($_REQUEST['env'] == 'gito')
31 | {
32 | $pest = new PestJSON('http://localhost/development/tlrepo/lib/api/rest/v1/');
33 | }
34 |
35 | $password = $user = 'dev01';
36 | $pest->setupAuth($user, $password);
37 |
38 | $item = array();
39 | $item['testPlanID'] = 1185;
40 | $item['buildID'] = 1;
41 | $item['platformID'] = 0;
42 | $item['testCaseExternalID'] = 'TX::1';
43 | $item['notes'] = 'This is an execution created via REST API';
44 | $item['statusCode'] = 'p';
45 | $item['executionType'] = 1;
46 | $item['executionTimeStamp'] = '2012-03-27 06:09:00';
47 |
48 |
49 |
50 |
51 | // How to test using cUrl
52 | // curl -i -X POST --data "jsonFile"-u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
53 | // -i include headers
54 | // -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
55 |
56 | echo '
IN CLIENT
';
57 | $xx = json_encode($item);
58 | var_dump($xx);
59 |
60 | echo '
THING GOT FROM SERVER
';
61 | $thing = $pest->post('/executions',$item);
62 | var_dump($thing);
63 |
--------------------------------------------------------------------------------
/rest-api/v1/php/testproject/createTestProject.php:
--------------------------------------------------------------------------------
1 | getBody()
11 | * I've got always null.
12 | * Seems that POST BODY is not created.
13 | *
14 | * Changing to PestJSON.php, did the trick
15 | *
16 | */
17 |
18 | require '../../../common/pest/PestJSON.php';
19 |
20 | if(!isset($_REQUEST['env']))
21 | {
22 | die('env not provided: valid options: bit,gito - call URL?env=');
23 | }
24 |
25 | if($_REQUEST['env'] == 'bit')
26 | {
27 | $pest = new PestJSON('http://localhost/development/bitbucket/testlink/lib/api/rest/v1/');
28 | }
29 |
30 | if($_REQUEST['env'] == 'gito')
31 | {
32 | $pest = new PestJSON('http://localhost/development/tlrepo/lib/api/rest/v1/');
33 | }
34 |
35 | $password = $user = 'dev01';
36 | $pest->setupAuth($user, $password);
37 |
38 | $item = array();
39 | $item['name'] = 'FrenchToJD(month, day, year)';
40 | $item['notes'] = 'This is a FrenchToJD';
41 | $item['color'] = '';
42 | $item['prefix'] = 'FTJD';
43 | $item['active'] = 1;
44 | $item['is_public'] = 1;
45 | $item['options'] = array();
46 | $item['options']['requirementsEnabled']=0;
47 | $item['options']['testPriorityEnabled'] = 1;
48 | $item['options']['automationEnabled'] = 1;
49 | $item['options']['inventoryEnabled'] = 0;
50 |
51 |
52 | // How to test using cUrl
53 | // curl -i -X POST --data "jsonFile"-u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
54 | // -i include headers
55 | // -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
56 |
57 |
58 | echo '
IN CLIENT
';
59 | $xx = json_encode($item);
60 | var_dump($xx);
61 |
62 | echo '
THING GOT FROM SERVER
';
63 | $thing = $pest->post('/testprojects',$item);
64 | var_dump($thing);
65 |
--------------------------------------------------------------------------------
/rest-api/v1/php/testproject/getProjects.php:
--------------------------------------------------------------------------------
1 | setupAuth($user, $password);
32 |
33 | echo 'Access ALL TESTPROJECTS
';
34 | $thing = json_decode($pest->get('/testprojects'));
35 | echo '';var_dump($thing);echo '
';
36 |
37 |
38 | echo 'Access Only ONE TESTPROJECT
';
39 | $ox = (object) array('id' => 1208);
40 | echo 'Route:' . '/testprojects/' . $ox->id;
41 |
42 | $thing = json_decode($pest->get('/testprojects/' . $ox->id));
43 | echo '';var_dump($thing);echo '
';
44 |
45 |
46 |
47 | echo 'Access Only ONE TESTPROJECT
';
48 | $ox = (object) array('id' => 'Slim REST Framework');
49 | echo 'Route:' . '/testprojects/' . $ox->id;
50 |
51 | $thing = json_decode($pest->get('/testprojects/' . urlencode($ox->id)));
52 | echo '';var_dump($thing);echo '
';
53 |
--------------------------------------------------------------------------------
/rest-api/v1/php/testproject/getTestCasesInTestProject.php:
--------------------------------------------------------------------------------
1 | setupAuth($user, $password);
32 |
33 | echo 'Access ALL TEST CASES present in a test project
';
34 | $thing = json_decode($pest->get('/testprojects/94/testcases'));
35 | echo '';var_dump($thing);echo '
';
36 |
--------------------------------------------------------------------------------
/rest-api/v1/php/testproject/getTestPlansInTestProject.php:
--------------------------------------------------------------------------------
1 | setupAuth($user, $password);
32 |
33 | echo 'Access ALL TEST PLANS present in a test project (Accessible to user ??)
';
34 | $thing = json_decode($pest->get('/testprojects/94/testplans'));
35 | echo '';var_dump($thing);echo '
';
36 |
--------------------------------------------------------------------------------
/rest-api/v2/README:
--------------------------------------------------------------------------------
1 | Directory content
2 |
3 | json
4 | files that can be used as API documentation and also to test TestLink REST API using curl
5 |
6 | curl
7 | bash scripts to test TestLink REST API using curl
8 |
9 | php
10 | php examples of TestLink REST API usage
11 |
--------------------------------------------------------------------------------
/rest-api/v2/curl/builds/createBuild.sh:
--------------------------------------------------------------------------------
1 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
2 | # -i include headers
3 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
4 | # -u user:password
5 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
6 | # or - if you want curl to read the data from stdin.
7 | # The contents of the file must already be URL-encoded.
8 | # Multiple files can also be specified.
9 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
10 | #
11 | echo 'Testing TestLink REST API - POST /builds'
12 | curl -i -H "Content-Type: application/json" \
13 | -X POST --data "@../../json/createBuild.json" \
14 | -u b8359492ca233fd1ce55d6363cd026cf:b8359492ca233fd1ce55d6363cd026cf \
15 | http://localhost/development/github/testlink-code/lib/api/rest/v2/builds
--------------------------------------------------------------------------------
/rest-api/v2/curl/builds/createKeyword.sh:
--------------------------------------------------------------------------------
1 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
2 | # -i include headers
3 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
4 | # -u user:password
5 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
6 | # or - if you want curl to read the data from stdin.
7 | # The contents of the file must already be URL-encoded.
8 | # Multiple files can also be specified.
9 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
10 | #
11 | echo 'Testing TestLink REST API - POST /keywords'
12 | curl -i \
13 | -H "Content-Type: application/json" \
14 | -H @{'custom_header'='custom_header_value'} \
15 | -X POST --data "@../../json/createKeyword.json" \
16 | -u b8359492ca233fd1ce55d6363cd026cf:b8359492ca233fd1ce55d6363cd026cf \
17 | http://localhost/development/github/testlink-code/lib/api/rest/v2/keywords
--------------------------------------------------------------------------------
/rest-api/v2/curl/callisthenics/README:
--------------------------------------------------------------------------------
1 | Test simple methods to understand if REST API is up & running
--------------------------------------------------------------------------------
/rest-api/v2/curl/callisthenics/who.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
3 | # -i include headers
4 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
5 | # -u user:password
6 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
7 | # or - if you want curl to read the data from stdin.
8 | # The contents of the file must already be URL-encoded.
9 | # Multiple files can also be specified.
10 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
11 | #
12 | clear
13 | echo 'Testing TestLink REST API - POST /who'
14 |
15 | curl -i -H "Content-Type: application/json" \
16 | -u restadminapikey:followthewitherabbitneo \
17 | http://localhost/development/github/testlink-code/lib/api/rest/v2/who
--------------------------------------------------------------------------------
/rest-api/v2/curl/keywords/createKeyword.sh:
--------------------------------------------------------------------------------
1 | # curl -i -X POST -u dev01:dev01 http://localhost/development/tlrepo/lib/api/rest/v1/testprojects
2 | # -i include headers
3 | # -X (HTTP) Specifies a custom request method to use when communicating with the HTTP server
4 | # -u user:password
5 | # --data If you start the data with the letter @, the rest should be a file name to read the data from,
6 | # or - if you want curl to read the data from stdin.
7 | # The contents of the file must already be URL-encoded.
8 | # Multiple files can also be specified.
9 | # Posting data from a file named 'foobar' would thus be done with --data @foobar.
10 | #
11 | echo 'Testing TestLink REST API - POST /keywords'
12 | curl -i \
13 | -H "Content-Type: application/json" \
14 | -H "APIKEY: b8359492ca233fd1ce55d6363cd026cf" \
15 | -X POST --data "@../../json/createKeyword.json" \
16 | -u developer:followthewitherabbitneo \
17 | http://localhost/development/github/testlink-code/lib/api/rest/v2/keywords
--------------------------------------------------------------------------------
/rest-api/v2/json/README:
--------------------------------------------------------------------------------
1 | Files present on this directory can be used to test TestLink REST API using curl
2 |
--------------------------------------------------------------------------------
/rest-api/v2/json/createBuild.json:
--------------------------------------------------------------------------------
1 | {
2 | "operation": "create build",
3 | "testplan": "134112",
4 | "name": "6.1@34455"
5 | }
--------------------------------------------------------------------------------
/rest-api/v2/json/createKeyword.json:
--------------------------------------------------------------------------------
1 | {
2 | "keyword": "ALFA K-134112",
3 | "notes": "This is a Keyword",
4 | "testProject": {"prefix": "JUN"}
5 | }
--------------------------------------------------------------------------------
/rest-api/v2/json/createTestCaseUsingAttrID.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case ALFA",
3 | "summary":"This is a summary for Test Case",
4 | "preconditions":"No preconditions",
5 | "order":100,
6 |
7 |
8 | "testProject":{"id":358},
9 | "testSuite":{"id":360},
10 |
11 | "author":{"id":1},
12 | "importance":{"id":2},
13 | "executionType":{"id":1},
14 | "status":{"id":1},
15 | "estimatedExecutionTime":0
16 | }
--------------------------------------------------------------------------------
/rest-api/v2/json/createTestCaseUsingAttrVerboseKey.json:
--------------------------------------------------------------------------------
1 | {
2 | "name":"Test Case ALFA",
3 | "summary":"This is a summary for Test Case",
4 | "preconditions":"No preconditions",
5 | "order":100,
6 |
7 | "testProject":{"prefix":"APR"},
8 | "testSuite":{"id":360},
9 |
10 | "author":{"login":"Mr Spock"},
11 | "importance":{"name":"high"},
12 | "executionType":{"name":"manual"},
13 | "status":{"name":"draft"},
14 | "estimatedExecutionTime":0
15 | }
--------------------------------------------------------------------------------
/sample-data/README.md:
--------------------------------------------------------------------------------
1 | The idea is provide some simple and silly data that can be used
2 | to discuss issues with the users.
3 |
4 | TS-100.barebones.xml
5 | Contains:
6 | 1 Test Suite TS-100
7 | 5 Test Cases (TC-1A,...,TC-1F) with 2 steps on each one.
8 | 3 Test Cases (TC-BX,TC-CX,TC-DX) without steps.
9 | NO Keywords
10 | NO Custom Fields
11 | NO Attachments
12 | NO Requirements
13 |
14 | 
15 |
16 | RSPEC-01-req-spec.barebones.xml
17 | Contains:
18 | 1 Req Specification
19 | 6 Requirements
20 |
21 | 
--------------------------------------------------------------------------------
/sample-data/RSPEC-01-req-spec.barebones.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 | <![CDATA[REQ-01 TITLE]]>
12 | 1
13 | 1
14 | 1
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 | <![CDATA[REQ-02 TITLE]]>
24 | 1
25 | 1
26 | 2
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 | <![CDATA[REQ-03 TITLE]]>
36 | 1
37 | 1
38 | 3
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 | <![CDATA[REQ-04 TITLE]]>
48 | 1
49 | 1
50 | 4
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 | <![CDATA[REQ-05 TITLE]]>
60 | 1
61 | 1
62 | 5
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 | <![CDATA[REQ-06 TITLE]]>
72 | 1
73 | 1
74 | 6
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
--------------------------------------------------------------------------------
/sample-data/TS-100.barebones.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |