aboutsummaryrefslogtreecommitdiffstats
path: root/puppet/services/ironic-api.yaml
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-02-15 13:15:29 +0000
committerGerrit Code Review <review@openstack.org>2017-02-15 13:15:29 +0000
commita309451920fa6d8f2120584b4778d6a7335fbca8 (patch)
treed56220d742e08fac9a082d50a1df1d1ab1844c8d /puppet/services/ironic-api.yaml
parent8424e2140d25fa7f47b9e8f2be03145f7a26c4a9 (diff)
parenteaafa9247ac089a5f801b272f4705dac89d021fe (diff)
Merge "OVN plugin configuration fixes"
Diffstat (limited to 'puppet/services/ironic-api.yaml')
0 files changed, 0 insertions, 0 deletions
34' href='#n134'>134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 
# Functest Framework

created by [Cédric Ollivier](mailto:cedric.ollivier@orange.com)

2017/06/05

Note:

- Functest integrates lots of heterogeneous testcases:
    - python vs bash
    - internal vs external
- it aims to benefit from object programming
    - to define common operations
    - to avoid conditional instructions regarding the testcases
    - to avoid duplicating code
    - to ease the integration of third-party testcases (written in Bash or Python)



## Quick overview


### Functest function calls

- **CI** calls *run_tests.py* (please see [jenkins jobs](https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=tree;f=jjb/functest))
- *run_tests.py* parses *functest/ci/testcases.yaml* to:
    - check which testcase(s) must be run
    - execute the common operations on every testcase (run, push its results to db...)
<!-- .element: class="fragment highlight-red"-->
    - return the right status code to **CI**


### Our target

- limit run_tests.py instructions by defining:
    - the basic testcase attributes
    - all common operations
    - the status codes expected
- avoid duplicating codes between testcases
- ease the development of third-party testcases (aka features)



## class TestCase

base model for single test case


### instance attributes

- project_name (default: 'functest')
- case_name
- criteria
- result
- start_time
- stop_time
- details


### methods

| Method            | Purpose                      |
|-------------------|------------------------------|
| run(**kwargs)     | run the test case            |
| is_successful()   | interpret the results        |
| get_duration()    | return the duration          |
| push_to_db()      | push the results to the DB   |
| clean()           | clean the resources          |


### run(**kwargs)

- the subclasses must override the default implementation which is false on purpose
- the new implementation must set the following attributes to push the results to DB:
    - result
    - start_time
    - stop_time


### class attributes

| Status code        | Returned when       |
|--------------------|---------------------|
| EX_OK              | everything is OK    |
| EX_RUN_ERROR       | run() failed        |
| EX_TESTCASE_FAILED | results are false   |
| EX_PUSH_TO_DB_ERROR| push_to_db() failed |


### run_tests.py

```python
module = importlib.import_module(run_dict['module'])
cls = getattr(module, run_dict['class'])
test_dict = ft_utils.get_dict_by_test(test_name)
test_case = cls(**test_dict)
try:
    kwargs = run_dict['args']
    result = test_case.run(**kwargs)
except KeyError:
    result = test_case.run()
if result == testcase.TestCase.EX_OK:
    if GlobalVariables.REPORT_FLAG:
        test_case.push_to_db()
    result = test_case.is_successful()
```



## Your first test case


### first.py

```python
#!/usr/bin/env python

import time

from functest.core import testcase

class Test(testcase.TestCase):

    def run(self, **kwargs):
        self.start_time = time.time()
        print "Hello World"
        self.result = 100
        self.stop_time = time.time()
        return testcase.TestCase.EX_OK
```


### functest/ci/testcases.yaml

```yaml
case_name: first
project_name: functest
criteria: 100
blocking: true
description: ''
dependencies:
    installer: ''
    scenario: ''
run:
    module: 'first'
    class: 'Test'
```



## class Feature
bases: TestCase

base model for single feature


### methods

| Method            | Purpose                   |
|-------------------|---------------------------|
| run(**kwargs)     | run the feature           |
| execute(**kwargs) | execute the Python method |


### run(**kwargs)

- allows executing any Python method by calling execute()
- sets the following attributes required to push the results to DB:
    - result
    - start_time
    - stop_time
- doesn't fulfill details when pushing the results to the DB.


### execute(**kwargs)

- the subclasses must override the default implementation which is false on purpose
- the new implementation must return 0 if success or anything else if failure.



## Your second test case


### second.py

```python
#!/usr/bin/env python

from functest.core import feature

class Test(feature.Feature):

    def execute(self, **kwargs):
        print "Hello World"
        return 0
```


### functest/ci/testcases.yaml

```yaml
case_name: second
project_name: functest
criteria: 100
blocking: true
description: ''
dependencies:
    installer: ''
    scenario: ''
run:
    module: 'second'
    class: 'Test'
```



## class BashFeature
bases: Feature

class designed to run any bash command


### execute(**kwargs)

execute the cmd passed as arg.



## Your third test case


### functest/ci/testcases.yaml

```
case_name: third
project_name: functest
criteria: 100
blocking: true
description: ''
dependencies:
    installer: ''
    scenario: ''
run:
    module: 'functest.core.feature'
    class: 'BashFeature'
    args:
        cmd: 'echo Hello World; exit 0'
```



## class Suite
bases: TestCase

base model for running unittest.TestSuite


### run(**kwargs)

- allows running any unittest.TestSuite
- sets the following attributes required to push the results to DB:
    - result
    - start_time
    - stop_time
    - details



## Your fourth test case


### fourth.py

```python
#!/usr/bin/env python

import unittest

class TestStringMethods(unittest.TestCase):

    def test_upper(self):
        self.assertEqual('Hello World'.upper(),
                         'HELLO WORLD')
```


### functest/ci/testcases.yaml

```
case_name: fourth
project_name: functest
criteria: 100
blocking: true
description: ''
dependencies:
    installer: ''
    scenario: ''
run:
    module: 'functest.core.unit'
    class: 'Suite'
    args:
        name: 'fourth'
```



## class VNF
bases: TestCase

base model for VNF onboarding testing


### methods

| Method                | Purpose                                           |
|-----------------------|---------------------------------------------------|
| prepare()             | prepare VNF env (user, tenant, security group,..) |
| run(**kwargs)         | run VNF test case                                 |
| deploy_orchestrator() | deploy cloudify, ONAP, OpenBaton,... (optional)   |
| deploy_vnf()          | deploy the VNF                                    |
| test_vnf()            | run tests on the VNF                              |


### run(**kwargs)

- deploys an orchestrator if needed (e.g. heat, OpenBaton, Cloudify, ONAP, Juju)
- deploys the VNF
- performs tests on the VNF


### prepare()

- creates a user
- creates a Tenant/Project
- allocates admin role to the user on this tenant


### deploy_orchestrator()

- deploys an orchestrator (optional)
- if this function is overridden then raise orchestratorDeploymentException if error during orchestrator deployment


### deploy_vnf()

- **MUST be implemented** by vnf test cases. The details section MAY be updated in the vnf test cases.
- The deployment can be executed via a specific orchestrator or using build-in orchestrators such as heat, openbaton, cloudify, juju, ONAP, ...
- returns:
  True if the VNF is properly deployed
  False if the VNF is not deployed
- raises VnfDeploymentException if error during VNF deployment


### test_vnf()

- **MUST be implemented** by vnf test cases. The details section MAY be updated in the vnf test cases.
- Once a VNF is deployed, it is assumed that specific test suite can be run to validate the VNF.
- returns:
  True if VNF tests are PASS
  False if test suite is FAIL
- raises VnfTestException if error during VNF tests



## Your fifth test case


### fifth.py

```python
#!/usr/bin/env python

from functest.core import vnf

class Vnf(vnf.VnfOnBoarding):

    def deploy_vnf(self):
        print "Deploy your VNF here"
        print "Feed orchestrator with VNF descriptor"
        return 0

    def test_vnf(self):
        print "Test your VNF here"
        return 0
```


### functest/ci/testcases.yaml

```yaml
case_name: fifth
project_name: functest
criteria: 100
blocking: true
description: ''
dependencies:
    installer: ''
    scenario: ''
run:
    module: 'fifth'
    class: 'Vnf'
```



## Thank You!