Magento2.3 API Functional Testing

© 2019 Magento, Inc. Page | 1
API Functional
Testing in Magento 2.3

© 2019 Magento, Inc.
.
Page | 2
Senior Software Developer at BORN Group
Vishwas Bhatnagar
https://www.linkedin.com/in/vishwasbhatnagar/

Agenda

Agenda
• Testing In Magento 2
• What is API Functional Testing ?
• Why Do we need API Functional Testing
• API Functional test case writing
• Configuring , running and cleanup after test cases

Not In Scope

Not in Scope
• Unit Tests
• Integrations Tests
• Functional Tests
• Magento Testing Framework using Selenium

Testing In Magento 2

Tests available in Magento 2
 Unit Tests
 Integration Tests
 Functional Tests
 Performance Tests
 Static Code Analysis Tests
 JavaScript Tests
 Integrity Tests
 Legacy Tests

Unit Testing
 Individual classes or functions in isolation
 Resides in dev/tests/unit

Integration Tests
• Interactions between
components, layers, and the
environment
• dev/tests/integration

Functional Tests
 Same way user would interact
 dev/tests/functional and dev/tests/api-functional
Functional
Test
API
Functional
MTF

Performance Tests
 Track and maintain performance level per build
 dev/tests/performance

Few more tests
 Static Code Analysis Tests :
 Static code analysis checks that PHP code
follows the Magento 2 coding standards and
best practices(dev/tests/static)
 JavaScript Tests :
 Tests the accuracy of JavaScript functions.
 (dev/tests/js).
 Integrity testing
 check how an application is linked.
 Basically, they tell us if your application
should be able to run.
 Legacy Tests

What is API Functional
Testing ?

API Functional Tests
• Process used within software
development in which software
is tested to ensure that it
conforms with all
requirements.
• Makes sure that nothing visible
to the customer broke.
• Don't care about how
something is built
• Don't care How something
works at a high level

Why Do we need API
Functional Testing

API Functional Testing Advantages
• Adheres with Agile software
Development
• Testing parallel with
development
• Finds problems early in the
development cycle
• Allows easy the programmer to
refactor code or upgrade
• Writing the test first forces you
to think through your design
and what it must accomplish
before you write the code

Getting Started

.
Page | 19
Writing Test cases
• Should inherit from the generic test case
MagentoTestFrameworkTestCaseWebapiAbstract.
• Should Use ObjectManager for testing in isolation
• Class /File name should end with test
• Methods should start with test
• All Methods should be declared public

.
Page | 20
Sample Test cases

.
Page | 21
Assertions
You can make various assertions that
are available in
phpunitFrameworkAssert like
• assertArrayHasKey
• assertCount
• assertSame
• assertEquals
• assertNotEmpty
• assertGreaterThan
• assertIsReadable
• assertNotNull

.
Page | 22
Assertion Example

Running Test Cases

.
Page | 24
Configuring magento to run tests
• Copy /dev/tests/api-functional/phpunit_rest.xml.dist to
/dev/tests/api-functional/phpunit_rest.xml

.
Page | 25
Configuring magento to run tests
• Copy /dev/tests/api-functional/config/install-config-
mysql.php.dist to /dev/tests/api-functional/config/install-config-
mysql.php.
• Configure your DB connection and install

.
Page | 26
Running Using CLI
• Switch to M2_ROOT/dev/test/api-fuctional/
• To Run Test class
– ../../../vendor/bin/phpunit --debug
../../../app/code/Born/VehicleSearch/Test/Api/JobPostTest
• To run a test method
– ../../../vendor/bin/phpunit --debug --filter testJobSaveNoAction
../../../app/code/Born/Jobs/Test/Api/JobPostTest

.
Page | 27
Running Using CLI

.
Page | 28
Analyzing the Test Result

Complex Test case Writing ?

Use DocBlock Annotations
@magentoAppIsolation :
• Enable and Disable
• Application state after a test
run will be the same as before
the test run
@magentoDbIsolation :
• Enable and Disable
• All data, required for a test,
live during transaction only.
Any test results won’t be
written in a database.

@magentoDataFixture/magentoApiDataFixture:
• Used to setup environment
• All data, required for a test, live during transaction only. Any test results
won’t be written in a database
@magentoAppArea :
• Adminhtml | frontend | global
• Set area to application

@magentoCache:
• <type>|all enabled|disabled
• Disables cache
@magentoConfigFixture :
• [<store_code>_store] <config_path> <config_value>
• Configuration values for individual tests and revert them after the test
execution

.
Page | 33
Fixture Example

Clean it Up !

Cleaning data after test case execution
• RollBack Scripts
– If you use fixtures to insert
data you can create a rollback
script for it .
– Same format as the
corresponding fixture: a script
or a method
– Should be Stored in the same
directory
– Same class as the
corresponding fixture and
suffixed with Rollback

.
Page | 36
Script
Fixture : Magento/Catalog/_files/categories.php
RollBack : Magento/Catalog/_files/categories_rollback.php
Method
Fixture : MagentoCatalogModelProductTest::prepareProduct
RollBack : MagentoCatalogModelProductTest::prepareProductRollback

.
Page | 37
• TearDown Method
– If you want to perform any actions after constraints
– To be included in test case file

Questions ?

Thank You

Magento2.3 API Functional Testing

More Related Content

What's hot

Similar to Magento2.3 API Functional Testing

Recently uploaded

Magento2.3 API Functional Testing