testoptimal.api

Class AgentAPI

java.lang.Object

testoptimal.api.AgentAPI

public class AgentAPI
extends Object

Copyright 2020 TestOptimal LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Author:

Yaxiong Lin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AgentAPI.MbtSessInfo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AgentAPI(Server svr_p)

Method Summary

Modifier and Type	Method and Description
void	closeModel(String modelName_p) to close the model (release memory).
String	getAgentID() returns the agentID.
RunResult	getModelStats(String modelName_p) retrieves model execution stats for a model execution
String	getNextCmd() retrieves the next command from the model.
String	getNextCmd(long timeoutMillis_p) retrieves the next command from the model.
protected void	modelClosed()
String	regAgent(String modelName_p) register agent to TestOptimal to be connected to the running model.
String	setResult(boolean isSuccess_p, String result_p) sends the result back to the model to be recorded.
String	setResult(boolean isSuccess_p, String result_p, String reqTag_p)
String	setResult(boolean isSuccess_p, String result_p, String reqTag_p, String assertID_p)
String	setResult(boolean isSuccess_p, String result_p, String reqTag_p, String assertID_p, Map<String,Object> moreAttrs_p)
String	startModel(String modelName_p) starts model execution on TestOptimal server with default sequencer Optimal.
String	startModel(String modelName_p, Constants.MbtMode mbtMode_p) starts model execution on TestOptimal server with specified sequencer/MBT Mode.
String	startModel(String modelName_p, List<Trans> transList_p, boolean optimal_p) starts model execution on TestOptimal server to cover the transitions specified.
void	stopModel() to interrupt model execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentAPI

protected AgentAPI(Server svr_p)

Method Detail

getAgentID

public String getAgentID()

returns the agentID.

Returns:

agent ID

startModel

public String startModel(String modelName_p)
                  throws APIError

starts model execution on TestOptimal server with default sequencer Optimal.

Parameters:

modelName_p - model name

Returns:

mbtSessID model execution sesson ID

Throws:

APIError - on any error

startModel

public String startModel(String modelName_p,
                         Constants.MbtMode mbtMode_p)
                  throws APIError

starts model execution on TestOptimal server with specified sequencer/MBT Mode.

Parameters:

modelName_p - model name

mbtMode_p - Optimal, Priority, Pairwise, Random

Returns:

mbtSessID model execution sesson ID

Throws:

APIError - on any error

startModel

public String startModel(String modelName_p,
                         List<Trans> transList_p,
                         boolean optimal_p)
                  throws APIError

starts model execution on TestOptimal server to cover the transitions specified.

Parameters:

modelName_p - model name

transList_p - List of transitions to be covered.

optimal_p - true if to generate minimal number of test steps, false to cover the transitions in the order specified in tranList_p.

Returns:

mbtSessID model execution sesson ID

Throws:

APIError - on any error

regAgent

public String regAgent(String modelName_p)
                throws APIError

register agent to TestOptimal to be connected to the running model. Model must be started with startModel(...).

Parameters:

modelName_p - model name

Returns:

agentID agent ID

Throws:

APIError - on any error

getNextCmd

public String getNextCmd()
                  throws APIError

retrieves the next command from the model.

Returns:

command text. Blank/null indicates the model execution has completed.

Throws:

APIError - on any error

getNextCmd

public String getNextCmd(long timeoutMillis_p)
                  throws APIError

retrieves the next command from the model.

Parameters:

timeoutMillis_p - number of milliseconds the agent should wait for the next command from TestOptimal server.

Returns:

command text. Blank/null indicates the model execution has completed.

Throws:

APIError - on any error

setResult

public String setResult(boolean isSuccess_p,
                        String result_p)
                 throws APIError

sends the result back to the model to be recorded.

Parameters:

isSuccess_p - true to record the current test step as success/passed. false to record as failed.

result_p - text result

Returns:

response from svr for debugging

Throws:

APIError - on any error

setResult

public String setResult(boolean isSuccess_p,
                        String result_p,
                        String reqTag_p)
                 throws APIError

Parameters:

isSuccess_p - true or false

result_p - passed or failed message

reqTag_p - requiremet tag/code

Returns:

response from svr for debugging

Throws:

APIError - on any error

setResult

public String setResult(boolean isSuccess_p,
                        String result_p,
                        String reqTag_p,
                        String assertID_p)
                 throws APIError

Parameters:

isSuccess_p - true or false

result_p - passed or failed message

reqTag_p - requiremet tag/code

assertID_p - identifier to be assigned to the check - either passed or failed.

Returns:

response from svr for debugging

Throws:

APIError - on any error

setResult

public String setResult(boolean isSuccess_p,
                        String result_p,
                        String reqTag_p,
                        String assertID_p,
                        Map<String,Object> moreAttrs_p)
                 throws APIError

Parameters:

isSuccess_p - true or false

result_p - passed or failed message

reqTag_p - requiremet tag/code

assertID_p - identifier to be assigned to the check - either passed or failed.

moreAttrs_p - additional attributes in Map<String, Object> to be passed to the model.

Returns:

response from svr for debugging

Throws:

APIError - on any error

stopModel

public void stopModel()
               throws APIError

to interrupt model execution.

Throws:

APIError - on any error

closeModel

public void closeModel(String modelName_p)
                throws APIError

to close the model (release memory).

Parameters:

modelName_p - model name

Throws:

APIError - on any error

getModelStats

public RunResult getModelStats(String modelName_p)
                        throws APIError

retrieves model execution stats for a model execution

Parameters:

modelName_p - model name

Returns:

RunResult containing the model execcution stats

Throws:

APIError - on any error

modelClosed

protected void modelClosed()