Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 3.1 KB

0131-test-scripts-common-modules-refactoring.md

File metadata and controls

96 lines (65 loc) · 3.1 KB
Raw

Test Scripts - Refactoring of Common modules

Introduction

ATF test scripts use a lot of functions in commonly used modules, like:

  • data accessors: file, database
  • functions for tables: print, copy
  • sequences:
    • create mobile session
    • register/activate mobile application
    • perform policy table update
  • etc.

All these functionality are not tests artifacts but tools that tests use.

The purpose of this proposal is to clean up these common modules that everyone is able to use while creating ATF test scripts.

Motivation

Current downsides of common modules are:

  • There is no clear structure
  • Lack of description for huge amount of functions
  • There is no single standard for the functions
  • Some functions are duplicated
  • A lot of outdated and unused code

Proposed solution

In order to clean up the common modules there are following items needs to be done.

Leave existing modules as is for backward compatibility

By leaving all existing modules currently located in ./user_modules folder as is it will be possible to use all existing ATF test scripts without changes.

Design a standard template for functions

Each function in common modules should follow a template. E.g.:

--[[ @jsonFileToTable: convert .json file to table
--! @parameters:
--! pFileName - input file name
--! @return: table with data
--]]
local function jsonFileToTable(pFileName)
  local f = io.open(pFileName, "r")
  local content = f:read("*all")
  f:close()
  return json.decode(content)
end

Create new folders structure

In test scripts repository create the following folders structure:

  ./common_modules/
          utils/
          sequences/
  • utils - folder for modules with utility functions (e.g.: data accessors, table functions, data converters, etc.)
  • sequences - folder for modules with common sequences (e.g.: register/activate mobile application, policy update, put file, etc.)

Transfer most used common functions into a new folder

Most used functions need to be transferred from existing "user_modules" to a new "common_modules" folder in appropriate module file. Also they need to be updated according to a new template. A few functions can be placed in one module file.

Follow new approach when developing new ATF test scripts

  • In newly created ATF scripts use only functions from new "common_modules" folder and not from an old "user_modules" one
  • If some utility or common sequence function doesn't exist - create it in a new "common_modules" in appropriate module file using standard template

Potential downsides

Existing ATF test scripts must be updated if some function from new common modules is required.

Impact on existing code

Since new common modules is going to be implemented in a new separate folder there will be no impact on existing code.

Alternatives considered

Use current approach.