com.xceptance.xlt.nocoding.command.action.subrequest.XhrSubrequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xlt-nocoding Show documentation
A library based on XLT to run Web test cases that are written in either YAML or CSV format.
The newest version!
/*
 * Copyright (c) 2013-2023 Xceptance Software Technologies GmbH
 *
 * 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.
 */
package com.xceptance.xlt.nocoding.command.action.subrequest;

import java.util.List;

import com.xceptance.xlt.nocoding.command.action.AbstractActionSubItem;
import com.xceptance.xlt.nocoding.command.action.request.Request;
import com.xceptance.xlt.nocoding.command.action.response.Response;
import com.xceptance.xlt.nocoding.util.ActionSubItemUtil;
import com.xceptance.xlt.nocoding.util.context.Context;

/**
 * Creates a {@link XhrSubrequest} that has a name and consists of a {@link Request}, and optionally a {@link Response}
 * and maybe multiple {@link AbstractSubrequest}.
 *
 * @author ckeiner
 */
public class XhrSubrequest extends AbstractSubrequest
{
    /**
     * The name of the subrequest
     */
    private String name;

    /**
     * The request, response and subrequests of this subrequest
     */
    private final List actionItems;

    /**
     * Creates an instance of {@link XhrSubrequest} that sets the {@link #name} and {@link #actionItems}
     *
     * @param name
     *            The name of the subrequest
     * @param actionItems
     *            A list of {@link AbstractActionSubItem}s
     */
    public XhrSubrequest(final String name, final List actionItems)
    {
        this.name = name;
        this.actionItems = actionItems;
    }

    /**
     * Executes the subrequest by first creating a local {@link Context} out of the method parameter. Then, it asserts
     * the order of the {@link #actionItems}. Then, sets the {@link Request} in the {@link #actionItems} up. Finally,
     * executes the {@link #actionItems}.
     */
    @Override
    public void execute(final Context context) throws Exception
    {
        // Create a new local context, so we do not overwrite the old context
        final Context localContext = context.buildNewContext();

        // Assert that the order of Request, Response, Subrequest is correct
        ActionSubItemUtil.assertOrder(actionItems);
        fillDefaultData(localContext);

        // Get the request
        final Request request = ((Request) actionItems.iterator().next());
        // Set Xhr to true
        request.setXhr("true");
        // Set XhrSubrequest specific headers
        request.getHeaders().put("X-Requested-With", "XMLHttpRequest");
        request.getHeaders().put("Referer", context.getWebResponse().getWebRequest().getUrl().toString());

        // Try and catch to add the name of the XhrSubrequest to the Exception
        try
        {
            // Execute every actionItem
            for (final AbstractActionSubItem actionItem : actionItems)
            {
                actionItem.execute(localContext);
            }
        }
        catch (final Exception e)
        {
            throw new Exception("XhrSubrequest \"" + name + "\" failed because " + e.getMessage(), e);
        }
    }

    public String getName()
    {
        return name;
    }

    /**
     * Sets name and request to the default name and request if they aren't not specified
     */
    @Override
    public void fillDefaultData(final Context context)
    {
        if (name == null || name.isEmpty())
        {
            name = ActionSubItemUtil.getDefaultName(context, "XhrSubrequest");
        }
        ActionSubItemUtil.fillDefaultData(actionItems, context);
    }

    public List getActionItems()
    {
        return actionItems;
    }

}