Macro (Vision)

It’s very important to reuse test code. You can register routine work as macro.

Creating macro object/function

1. Create an object class in any place under src/test/kotlin. For example, create macro package directory, then create MacroObject1.
   
   
   
2. Implement code as follows.
   1. Put @MacroObject annotation on the object class.
   2. Inherit from TestDrive interface.
   3. Create a function and put @Macro annotation on it.

package macro

import shirates.core.macro.Macro
import shirates.core.macro.MacroObject
import shirates.core.vision.driver.commandextension.tap
import shirates.core.vision.driver.commandextension.waitScreen
import shirates.core.vision.testcode.VisionTest

@MacroObject
object MacroObject1 : VisionTest() {

    @Macro("[Network preferences Screen]")
    fun internetScreen() {

        it.waitScreen("[Android Settings Top Screen]")
            .tap("Network & internet")
        it.waitScreen("[Network & internet Screen]")
            .tap("Internet")
        it.waitScreen("[Internet Screen]")
            .tap("Network preferences")
    }

}

1. Build the project. The class file of the macro is output in out directory.
   

Calling macro function

1. Create class Macro1 under kotlin/exercise.
2. Implement test code as follows.

package exercise

import org.junit.jupiter.api.Order
import org.junit.jupiter.api.Test
import shirates.core.vision.driver.commandextension.exist
import shirates.core.vision.driver.commandextension.macro
import shirates.core.vision.testcode.VisionTest

class Macro1 : VisionTest() {

    @Test
    @Order(10)
    fun macro1() {

        scenario {
            case(1) {
                action {
                    it.macro("[Network preferences Screen]")
                }.expectation {
                    it.exist("Install certificates")
                }
            }
        }
    }
}

Run the test code. You can see a log line on console as follows.

[info]	()	Registering macro. (macro.MacroObject1)

Link

• index