utils/test/result_collection_api/opnfv_testapi/router/url_mappings.py

   1 ##############################################################################
   2 # Copyright (c) 2015 Orange
   3 # guyrodrigue.koffi@orange.com / koffirodrigue@gmail.com
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9 from opnfv_testapi.resources.handlers import VersionHandler
  10 from opnfv_testapi.resources.testcase_handlers import TestcaseCLHandler, \
  11     TestcaseGURHandler
  12 from opnfv_testapi.resources.pod_handlers import PodCLHandler, PodGURHandler
  13 from opnfv_testapi.resources.project_handlers import ProjectCLHandler, \
  14     ProjectGURHandler
  15 from opnfv_testapi.resources.result_handlers import ResultsCLHandler, \
  16     ResultsGURHandler
  17 from opnfv_testapi.resources.dashboard_handlers import DashboardHandler, \
  18     DashboardProjectsHandler
  19
  20
  21 mappings = [
  22     # GET /versions => GET API version
  23     (r"/versions", VersionHandler),
  24
  25     # few examples:
  26     # GET /api/v1/pods => Get all pods
  27     # GET /api/v1/pods/1 => Get details on POD 1
  28     (r"/api/v1/pods", PodCLHandler),
  29     (r"/api/v1/pods/([^/]+)", PodGURHandler),
  30
  31     # few examples:
  32     # GET /projects
  33     # GET /projects/yardstick
  34     (r"/api/v1/projects", ProjectCLHandler),
  35     (r"/api/v1/projects/([^/]+)", ProjectGURHandler),
  36
  37     # few examples
  38     # GET /projects/qtip/cases => Get cases for qtip
  39     (r"/api/v1/projects/([^/]+)/cases", TestcaseCLHandler),
  40     (r"/api/v1/projects/([^/]+)/cases/([^/]+)", TestcaseGURHandler),
  41
  42     # new path to avoid a long depth
  43     # GET /results?project=functest&case=keystone.catalog&pod=1
  44     #   => get results with optional filters
  45     # POST /results =>
  46     # Push results with mandatory request payload parameters
  47     # (project, case, and pod)
  48     (r"/api/v1/results", ResultsCLHandler),
  49     (r"/api/v1/results/([^/]+)", ResultsGURHandler),
  50
  51     # Method to manage Dashboard ready results
  52     # GET /dashboard?project=functest&case=vPing&pod=opnfv-jump2
  53     #  => get results in dasboard ready format
  54     # get /dashboard
  55     #  => get the list of project with dashboard ready results
  56     (r"/dashboard/v1/results", DashboardHandler),
  57     (r"/dashboard/v1/projects", DashboardProjectsHandler),
  58 ]