Log test scenario output

Use the Log class methods to output errors, warnings, and information from test scenarios as they play.

In the play method of your Java test scenarios, for example, to have information about errors, warnings, or debug information displayed as the test is running, add calls to the log class with the required log method, for example:

runner.log().error("This is bad...");  // for the error
runner.log().warning("Beware !!! ");  //for the warning
runner.log().info("Just to tell you..."); //for the info
runner.log().debug("Bug to report...");  //for debug info

public void play(GhostRunner runner)
	{
		try {
			runner.sendAction("INPUT");
			ArrayList<FieldInfo> fields = runner.getFields();
			for (FieldInfo field : fields) {
				runner.log().info(field.getId(), " / ", field.getName(), " / ", field.getType());
			}
			runner.sendAction("close");
			runner.close();
		} catch (GhostException e) {
			runner.log().error("ButtonEditDelegatedScenario: exception raised!", e);
		} catch (Exception e) {
			runner.log().error(e);
		}

		...
		runner.log().info(this.getClass().getName(), " ended successfully");
	}

In this code sample from the ButtonEditScenario class sample, the ButtonEdit application from the FGLGWS demo is being tested. The runner.sendaction("INPUT"); method selects the INPUT button of the application. This opens a form for user input.

The runner.getFields() method gets details about the form fields; their id, name, and type. Using the runner.log().info method outputs this information.

In the catch block, any exception raised by the GhostException method can also be logged as an error by the runner.log().error method.

Image shows the log outputted by the ButtonEditScenario test on the ButtonEdit demo application run by the Ghost Client

Figure 1. ButtonEdit scenario log output

You can adjust the log level with the GHOSTLOG environment variable. This will effect what is outputted to the display, but bear in mind it depends on how detailed the logging is in your test play method.

If GHOSTLOG is set to ERROR, only errors will be displayed on the output.

If set to WARNING, errors and warnings are displayed.

If set to INFO, errors, warnings, and info are displayed.

If set to DEBUG, errors, warnings, info, and debug information, basically everything is displayed.