summaryrefslogtreecommitdiffstats
path: root/functest/api/urls.py
blob: 59bf7d51c2e8da7450eb471f9ce6f666fb46043b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
#!/usr/bin/env python

# Copyright (c) 2017 Huawei Technologies Co.,Ltd and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0

"""
Define multiple URLs
"""


class Url(object):  # pylint: disable=too-few-public-methods
    """ Url Class """

    def __init__(self, url, target):
        super(Url, self).__init__()
        self.url = url
        self.target = target


URLPATTERNS = [
    # GET /api/v1/functest/envs => GET environment
    Url('/api/v1/functest/envs', 'v1_envs'),

    # POST /api/v1/functest/envs/action
    # {"action":"prepare"} => Prepare environment
    # {"action":"update_hosts", "args": {}} => Update hosts info
    Url('/api/v1/functest/envs/action', 'v1_envs'),

    # GET /api/v1/functest/openstack/credentials => GET credentials
    Url('/api/v1/functest/openstack/credentials', 'v1_creds'),

    # POST /api/v1/functest/openstack/action
    # {"action":"update_openrc", "args": {"openrc": {}}} => Update openrc
    Url('/api/v1/functest/openstack/action', 'v1_creds'),

    # GET /api/v1/functest/testcases => GET all testcases
    Url('/api/v1/functest/testcases', 'v1_test_cases'),

    # GET /api/v1/functest/testcases/<testcase_name>
    # => GET the info of one testcase
    Url('/api/v1/functest/testcases/<testcase_name>', 'v1_testcase'),

    # POST /api/v1/functest/testcases/action
    # {"action":"run_test_case", "args": {"opts": {}, "testcase": "vping_ssh"}}
    # => Run a testcase
    Url('/api/v1/functest/testcases/action', 'v1_testcase'),

    # GET /api/v1/functest/testcases => GET all tiers
    Url('/api/v1/functest/tiers', 'v1_tiers'),

    # GET /api/v1/functest/tiers/<tier_name>
    # => GET the info of one tier
    Url('/api/v1/functest/tiers/<tier_name>', 'v1_tier'),

    # GET /api/v1/functest/tiers/<tier_name>/testcases
    # => GET all testcases within given tier
    Url('/api/v1/functest/tiers/<tier_name>/testcases',
        'v1_testcases_in_tier'),

    # GET /api/v1/functest/tasks/<task_id>
    # => GET the result of the task id
    Url('/api/v1/functest/tasks/<task_id>', 'v1_tasks')
]