• Home
• net.luminis.jmeter
• jmeter-websocket-samplers
• 1.0
• source code
• WebSocketSamplerGuiPanel.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

eu.luminis.jmeter.wssampler.WebSocketSamplerGuiPanel Maven / Gradle / Ivy

/*
 * Copyright 2016, 2017 Peter Doornbosch
 *
 * This file is part of JMeter-WebSocket-Samplers, a JMeter add-on for load-testing WebSocket applications.
 *
 * JMeter-WebSocket-Samplers is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * JMeter-WebSocket-Samplers is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see .
 */
package eu.luminis.jmeter.wssampler;

import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.ButtonGroup;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JRadioButton;
import javax.swing.JTextField;
import javax.swing.SwingUtilities;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import java.awt.Color;
import java.awt.Component;
import java.awt.Cursor;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Pattern;

import static javax.swing.BoxLayout.X_AXIS;
import static javax.swing.BoxLayout.Y_AXIS;

abstract public class WebSocketSamplerGuiPanel extends JPanel {

    public static final Pattern DETECT_JMETER_VAR_REGEX = Pattern.compile("\\$\\{\\w+\\}");

    public static final int MIN_CONNECTION_TIMEOUT = WebsocketSampler.MIN_CONNECTION_TIMEOUT;
    public static final int MAX_CONNECTION_TIMEOUT = WebsocketSampler.MAX_CONNECTION_TIMEOUT;
    public static final int MIN_READ_TIMEOUT = WebsocketSampler.MIN_READ_TIMEOUT;
    public static final int MAX_READ_TIMEOUT = WebsocketSampler.MAX_READ_TIMEOUT;

    protected JComboBox protocolSelector;
    protected JTextField serverField;
    protected JTextField portField;
    protected JTextField pathField;
    protected JTextField connectionTimeoutField;
    protected JTextField readTimeoutField;
    protected JLabel portLabel;
    protected JLabel pathLabel;
    protected JLabel serverLabel;
    protected JRadioButton reuseConnection;
    protected JRadioButton newConnection;

    void clearGui() {
        protocolSelector.setSelectedItem("ws");
        serverField.setText("");
        portField.setText("");
        pathField.setText("");
    }

    /**
     * Creates a standard URL panel for configuring all URL components: protocol type (ws/wss), server, port, path.
     */
    protected JPanel createUrlPanel() {
        JPanel urlPanel = new JPanel() {
            @Override
            public void setEnabled(boolean enabled) {
                super.setEnabled(enabled);
                for (Component child: getComponents())
                    child.setEnabled(enabled);
            }
        };
        urlPanel.setLayout(new BoxLayout(urlPanel, X_AXIS));
        urlPanel.setBorder(BorderFactory.createCompoundBorder(BorderFactory.createEmptyBorder(5, 0, 0, 0),
                BorderFactory.createCompoundBorder(BorderFactory.createTitledBorder("Server URL"), BorderFactory.createEmptyBorder(3, 5, 5, 0))));

        protocolSelector = new JComboBox(new String[]{"ws", "wss"});
        urlPanel.add(protocolSelector);
        urlPanel.add(Box.createHorizontalStrut(10));
        serverLabel = new JLabel("Server name or IP:");
        urlPanel.add(serverLabel);
        serverField = new JTextField();
        serverField.setColumns(20);
        serverField.setMaximumSize(new Dimension(Integer.MAX_VALUE, serverField.getMinimumSize().height));
        urlPanel.add(serverField);
        portLabel = new JLabel("Port:");
        urlPanel.add(portLabel);
        portField = new JTextField();
        addIntegerRangeCheck(portField, 1, 65535);
        portField.setColumns(5);
        portField.setMaximumSize(portField.getPreferredSize());
        urlPanel.add(portField);
        pathLabel = new JLabel("Path:");
        urlPanel.add(pathLabel);
        pathField = new JTextField();
        pathField.setColumns(20);
        pathField.setMaximumSize(new Dimension(Integer.MAX_VALUE, pathField.getMinimumSize().height));
        urlPanel.add(pathField);

        return urlPanel;
    }

    /**
     * Creates a standard connection (settings) panel, including the choice to setup a new connection or reusing an existing one.
     */
    protected JPanel createConnectionPanel() {

        List connectionRelatedSettings = new ArrayList<>();

        ActionListener disableConnectionSettingsAction = new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                boolean enabled = e.getSource() == newConnection;
                for (JComponent c: connectionRelatedSettings)
                    c.setEnabled(enabled);
            }
        };

        JPanel connectionPanel = new JPanel();
        {
            connectionPanel.setLayout(new BoxLayout(connectionPanel, Y_AXIS));
            connectionPanel.setBorder(BorderFactory.createTitledBorder("Connection"));

            JPanel outerConnectionButtonPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
            {
                JPanel innerConnectionButtonPanel = new JPanel();
                {
                    innerConnectionButtonPanel.setLayout(new BoxLayout(innerConnectionButtonPanel, Y_AXIS));
                    reuseConnection = new JRadioButton("use existing connection");
                    reuseConnection.addActionListener(disableConnectionSettingsAction);
                    innerConnectionButtonPanel.add(reuseConnection);
                    newConnection = new JRadioButton("setup new connection");
                    newConnection.setSelected(true);
                    newConnection.addActionListener(disableConnectionSettingsAction);
                    innerConnectionButtonPanel.add(newConnection);

                    ButtonGroup connectionButtons = new ButtonGroup();
                    connectionButtons.add(newConnection);
                    connectionButtons.add(reuseConnection);
                }
                outerConnectionButtonPanel.add(innerConnectionButtonPanel);
            }
            connectionPanel.add(outerConnectionButtonPanel);

            JPanel urlPanel = createUrlPanel();
            {
                connectionRelatedSettings.add(urlPanel);
            }
            connectionPanel.add(urlPanel);

            JPanel connectionTimeoutPanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
            {
                connectionTimeoutPanel.setBorder(BorderFactory.createEmptyBorder(1, 4, 1, 0));
                JLabel connectionTimeoutLabel = new JLabel("Connection timeout (ms):");
                connectionTimeoutPanel.add(connectionTimeoutLabel);
                connectionTimeoutField = new JTextField();
                connectionTimeoutField.setColumns(10);
                connectionTimeoutPanel.add(connectionTimeoutField);
                JLabel connectionTimeoutErrorLabel = new JErrorMessageLabel();
                connectionTimeoutErrorLabel.setForeground(Color.RED);
                addIntegerRangeCheck(connectionTimeoutField, MIN_CONNECTION_TIMEOUT, MAX_CONNECTION_TIMEOUT, connectionTimeoutErrorLabel);
                connectionTimeoutPanel.add(connectionTimeoutErrorLabel);
                connectionRelatedSettings.add(connectionTimeoutLabel);
                connectionRelatedSettings.add(connectionTimeoutField);
                connectionRelatedSettings.add(connectionTimeoutErrorLabel);
            }
            connectionPanel.add(connectionTimeoutPanel);
        }
        return connectionPanel;
    }

    protected void setCreateNewConnection(boolean yesOrNo) {
        newConnection.setSelected(yesOrNo);
        reuseConnection.setSelected(! yesOrNo);
        ActionEvent changedSelectionEvent = new ActionEvent(yesOrNo? newConnection: reuseConnection, 0, "dummy");
        Arrays.stream(reuseConnection.getActionListeners()).forEach(l -> l.actionPerformed(changedSelectionEvent));
    }

    protected void addIntegerRangeCheck(final JTextField input, int min, int max) {
        addIntegerRangeCheck(input, min, max, null);
    }

    protected void addIntegerRangeCheck(final JTextField input, int min, int max, JLabel errorMsgField) {
        input.getDocument().addDocumentListener(new DocumentListener() {
            @Override
            public void insertUpdate(DocumentEvent e) {
                checkIntegerInRange(e.getDocument(), min, max, input, errorMsgField);
            }

            @Override
            public void removeUpdate(DocumentEvent e) {
                checkIntegerInRange(e.getDocument(), min, max, input, errorMsgField);
            }

            @Override
            public void changedUpdate(DocumentEvent e) {
                checkIntegerInRange(e.getDocument(), min, max, input, errorMsgField);
            }
        });
    }

    private boolean checkIntegerInRange(Document doc, int min, int max, JTextField field, JLabel errorMsgField) {
        boolean ok = false;
        boolean isNumber = false;

        try {
            String literalContent = stripJMeterVariables(doc.getText(0, doc.getLength()));
            if (literalContent.trim().length() > 0) {
                int value = Integer.parseInt(literalContent);
                ok = value >= min && value <= max;
                isNumber = true;
            } else {
                // Could be just a JMeter variable (e.g. ${port}), which should not be refused!
                ok = true;
            }
        }
        catch (NumberFormatException nfe) {
        }
        catch (BadLocationException e) {
            // Impossible
        }
        if (field != null)
            if (ok) {
                field.setForeground(Color.BLACK);
                if (errorMsgField != null)
                    errorMsgField.setText("");
            }
            else {
                field.setForeground(Color.RED);
                if (isNumber && errorMsgField != null)
                    errorMsgField.setText("Value must >= " + min + " and <= " + max);
            }
        return ok;
    }

    protected String stripJMeterVariables(String data) {
        return DETECT_JMETER_VAR_REGEX.matcher(data).replaceAll("");
    }

    boolean getTLS() {
        return "wss".equals(protocolSelector.getSelectedItem());
    }

    void setTLS(boolean tls) {
        if (tls)
            protocolSelector.setSelectedItem("wss");
        else
            protocolSelector.setSelectedItem("ws");
    }

    static JPanel createAboutPanel(JComponent parent) {
        JPanel aboutPanel = new JPanel();
        aboutPanel.setLayout(new FlowLayout(FlowLayout.RIGHT));
        JLabel aboutLabel = new JLabel("WebSocket Samplers plugin. Check for updates.");
        aboutLabel.addMouseListener(new MouseAdapter() {
            @Override
            public void mouseClicked(MouseEvent e) {
                AboutDialog.showDialog(SwingUtilities.getWindowAncestor(parent));
            }
        });
        aboutLabel.setFont(parent.getFont().deriveFont(Font.PLAIN, 10));
        aboutLabel.setCursor(new Cursor(Cursor.HAND_CURSOR));
        aboutPanel.add(aboutLabel);
        return aboutPanel;
    }

}