testoptimal.api

Class ModelAPI

java.lang.Object

testoptimal.api.ModelAPI

public class ModelAPI
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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelAPI(Server svr_p)

Method Summary

Modifier and Type	Method and Description
void	closeModel(String modelName_p) closes the model (to release memory).
RunResult	genPaths(String modelName_p) generate test paths (test cases) for a model (uploaded) using the default Optimal sequencer.
RunResult	genPaths(String modelName_p, Constants.MbtMode mbtMode_p) generate test paths (test cases) for a model (uploaded).
RunResult	genPaths(String modelName_p, Constants.MbtMode mbtMode_p, int timeoutMillis_p) generate test paths (test cases) for a model (uploaded).
RunResult	genPathsPartial(String modelName_p, List<Trans> transList_p, boolean optimal_p) generate test paths (test cases) to cover a subset of transitions in a model.
RunResult	genPathsPartial(String modelName_p, List<Trans> transList_p, boolean optimal_p, int timeoutMillis_p) generate test paths (test cases) to cover a subset of transitions in a model.
String	getGraphCoverage(String modelName_p, String outFilePath_p) download coverage graph for current model execution.
String	getGraphModel(String modelName_p, String outFilePath_p) download model graph.
String	getGraphMSC(String modelName_p, String outFilePath_p) download MSC graph for current model execution.
String	getGraphSequence(String modelName_p, String outFilePath_p) download sequence/traversal graph for current model execution.
Model	getModel(String modelName_p) retrieves model from TestOptimal server.
Map<String,Object>	runModel(RunRequest runReq_p) runs the model and waits for completion.
Map<String,Object>	runModel(String modelName_p) runs the model and waits for completion.
Map<String,Object>	runModelMCase(String modelName_p, String[] mcaseList_p) runs MCases on the model specified and waits for completion.
void	upload(Model model_p) uploads a model to TestOptimal server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelAPI

protected ModelAPI(Server svr_p)

Method Detail

upload

public void upload(Model model_p)
            throws APIError

uploads a model to TestOptimal server.

Parameters:

model_p - model object

Throws:

APIError - on any error

getModel

public Model getModel(String modelName_p)
               throws APIError

retrieves model from TestOptimal server.

Parameters:

modelName_p - model name

Returns:

model object

Throws:

APIError - on any error

genPaths

public RunResult genPaths(String modelName_p)
                   throws APIError

generate test paths (test cases) for a model (uploaded) using the default Optimal sequencer.

Parameters:

modelName_p - name of the model

Returns:

RunResult that contains the test paths and test steps.

Throws:

APIError - on any error

genPaths

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

generate test paths (test cases) for a model (uploaded).

Parameters:

modelName_p - name of the model

mbtMode_p - choose one of the model sequencers: Optimal, Priority, Pairwise, Random.

Returns:

RunResult that contains the test paths and test steps.

Throws:

APIError - on any error

genPaths

public RunResult genPaths(String modelName_p,
                          Constants.MbtMode mbtMode_p,
                          int timeoutMillis_p)
                   throws APIError

generate test paths (test cases) for a model (uploaded).

Parameters:

modelName_p - name of the model

mbtMode_p - choose one of the model sequencers: Optimal, Priority, Pairwise, Random.

timeoutMillis_p - # of milliseconds to wait for the generation to complete

Returns:

RunResult that contains the test paths and test steps.

Throws:

APIError - on any error

genPathsPartial

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

generate test paths (test cases) to cover a subset of transitions in a model.

Parameters:

modelName_p - name of the model (uploaded)

transList_p - list of transitions to be covered

optimal_p - true to generate minimal # of test steps to cover all transitions in transList_p, false to generate test path by covering the transitions in transList_p in the order they are listed.

Returns:

RunResult that contains the test paths and test steps.

Throws:

APIError - on any error

genPathsPartial

public RunResult genPathsPartial(String modelName_p,
                                 List<Trans> transList_p,
                                 boolean optimal_p,
                                 int timeoutMillis_p)
                          throws APIError

generate test paths (test cases) to cover a subset of transitions in a model.

Parameters:

modelName_p - name of the model (uploaded)

transList_p - list of transitions to be covered

optimal_p - true to generate minimal # of test steps to cover all transitions in transList_p, false to generate test path by covering the transitions in transList_p in the order they are listed.

timeoutMillis_p - # of milliseconds to wait for the generation to complete. 0 for no timeout

Returns:

RunResult that contains the test paths and test steps.

Throws:

APIError - on any error

runModel

public Map<String,Object> runModel(String modelName_p)
                            throws APIError

runs the model and waits for completion.

Parameters:

modelName_p - model name

Returns:

Map of these keys: statsURL status and mbtSessID. use statsURL to retrieve execution results (stats).

Throws:

APIError - on any error

runModel

public Map<String,Object> runModel(RunRequest runReq_p)
                            throws APIError

runs the model and waits for completion.

Parameters:

runReq_p - run request with execution options

Returns:

Map of these keys: statsURL status and mbtSessID. use statsURL to retrieve execution results (stats).

Throws:

APIError - on any error

runModelMCase

public Map<String,Object> runModelMCase(String modelName_p,
                                        String[] mcaseList_p)
                                 throws APIError

runs MCases on the model specified and waits for completion.

Parameters:

modelName_p - model name

mcaseList_p - list of MCase names to be executed.

Returns:

Map of these keys: statsURL status and mbtSessID. use statsURL to retrieve execution results (stats).

Throws:

APIError - on any error

closeModel

public void closeModel(String modelName_p)
                throws APIError

closes the model (to release memory). Do not use this method to close model execution started with AgentAPI.

Parameters:

modelName_p - model name

Throws:

APIError - on any error

getGraphModel

public String getGraphModel(String modelName_p,
                            String outFilePath_p)
                     throws APIError

download model graph.

Parameters:

modelName_p - model name

outFilePath_p - where to save the graph

Returns:

absolute file path to the graph saved

Throws:

APIError - on any error

getGraphCoverage

public String getGraphCoverage(String modelName_p,
                               String outFilePath_p)
                        throws APIError

download coverage graph for current model execution.

Parameters:

modelName_p - model name

outFilePath_p - where to save the graph

Returns:

absolute file path to the graph saved

Throws:

APIError - on any error

getGraphSequence

public String getGraphSequence(String modelName_p,
                               String outFilePath_p)
                        throws APIError

download sequence/traversal graph for current model execution.

Parameters:

modelName_p - model name

outFilePath_p - where to save the graph

Returns:

absolute file path to the graph saved

Throws:

APIError - on any error

getGraphMSC

public String getGraphMSC(String modelName_p,
                          String outFilePath_p)
                   throws APIError

download MSC graph for current model execution.

Parameters:

modelName_p - model name

outFilePath_p - where to save the graph

Returns:

absolute file path to the graph saved

Throws:

APIError - on any error