How do I abort an "open" action if some validation fails?

Question

question

AmeyaB asked Oct 8, '09 Spirent_Admin answered Apr 30, '13

How do I abort an "open" action if some validation fails?

I have an OpenHandler which performs some validation. I want to open the session only if the validation passes, otherwise I want to close the session immediately. I have the following lines of code in my OpenHandler:

// Open session only if no errors

if (valid()) {

SessionModel sessionModel = (SessionModel) model;

sessionModel.setOpen();

} else {

throw new ToolException("Cannot open session; validation failed.");

}

However this still opens the session if the validation fails. What do I need to change?

iTest sdk

10 |950

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Answer 1 · 2013-04-30T02:20:03Z

Spirent_Admin answered Apr 30, '13

The default behavior for all SDK Tools is that execution will continue even if the "open" step fails. More often than not, you want the execution to be aborted end as soon as the "open" step fails. To do this, follow these steps: 1. In your Session Profile, click on the Global Events page. 2. Scroll down to the "Tool" node, and select the "OnToolOpenSessionError" node. 3. Uncheck the "Inherit" checkbox; this allows you to over-ride that event. 4. Click on "Add" button, and select "AbortExecution" as the action. You can change the "AbortExecution" action to be any of the actions listed to suit your needs. You may also add additonal actions if required.

10 |950

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Answer 2 · 2009-10-09T22:16:48Z

AdamB answered Oct 9, '09 AdamB posted Oct 9, '09

Have you stepped through the code to make sure that:

1. your open handler is getting called

2. Your valid is returning false?

The code (which you can see and step through) in the SessionController does the following:

IRequestHandler openRequestHandler = open.getRequestHandler();
                if (openRequestHandler != null) {
                    try {
                        openRequestHandler.performRequest(this, getModel(), request, context, monitor);
                        if (model.getState() != SessionState.OPENED && model.getState() != SessionState.CLOSED) {
                            // if the tool fails to set the state to OPENED, then we set it to closed.
                            setOpeningToClose();
                            throw new ToolRuntimeException("Open Request Handler did not set the state to OPEN, and did not throw an exception on failure: "
                                    + toolDescriptor.getId());
                        }
                    } catch (Exception e) {
                        setOpeningToClose();
                        if (e instanceof ToolException) {
                            throw (ToolException) e;
                        } else {
                            throw new ToolException(e);
                        }
                    }
                } else {

If you fail to set the state to Open or you thrown an exception, it sets the state to "Close"

6

10 |950

Attachments: Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

AmeyaB ♦ commented · Oct 13, 2009 at 08:13 PM

Yes it's working now. For some reason I had to re-start Eclipse.

A follow-up question is where does the ToolException appear? It does not appear in my ErrorLog View.

0 ·

AdamB AmeyaB ♦ commented · Oct 13, 2009 at 09:28 PM

I think that there might be some issues with interactive errors. Does the view get a request response that is completed but has an error state? i.e. error issues?

0 ·

AmeyaB ♦ AdamB commented · Oct 13, 2009 at 09:32 PM

There are no issues in the Execution View.

0 ·

AdamB AmeyaB ♦ commented · Oct 13, 2009 at 09:34 PM

When are there no issues in the execution view? When you are running interactively? Or when you are "executing"? If the former, that is because the execution view is for execution. If the latter, then there is a bug. If you throw a tool exception during a step during execution, iTest should create an execution issue for that issue and put it in the execution view.

0 ·

AmeyaB ♦ AdamB commented · Oct 13, 2009 at 09:47 PM

There are no issues when running interactively, and I get the correct error issue during execution. So both behaviors are as intended.

So the only open issue is the one you identified: How do we display the error during interactive use?

0 ·

AdamB AmeyaB ♦ commented · Oct 13, 2009 at 10:38 PM

I believe that other tools are adding error issues to the request response and then the view is looking at the request response. If it has issues, it displays the error.

0 ·

question