utils/stc/src/main/java/org/onlab/stc/StepEvent.java

/*
 * Copyright 2015-present Open Networking Laboratory
 *
 * 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 org.onlab.stc;

import org.onlab.stc.Coordinator.Status;

import static java.lang.Long.parseLong;
import static org.onlab.stc.Coordinator.Status.valueOf;

/**
 * Represents an event of execution of a scenario step or group.
 */
public class StepEvent {

    private static final String SEP = "~";

    private final String name;
    private final long time;
    private final Status status;
    private final String command;

    /**
     * Creates a new step record.
     *
     * @param name    test step or group name
     * @param time    time in millis since start of epoch
     * @param status  step completion status
     * @param command step command
     */
    public StepEvent(String name, long time, Status status, String command) {
        this.name = name;
        this.time = time;
        this.status = status;
        this.command = command;
    }

    /**
     * Creates a new step record for non-running status.
     *
     * @param name    test step or group name
     * @param status  status
     * @param command step command
     */
    public StepEvent(String name, Status status, String command) {
        this(name, System.currentTimeMillis(), status, command);
    }

    /**
     * Returns the test step or test group name.
     *
     * @return step or group name
     */
    public String name() {
        return name;
    }

    /**
     * Returns the step event  time.
     *
     * @return time in millis since start of epoch
     */
    public long time() {
        return time;
    }

    /**
     * Returns the step completion status.
     *
     * @return completion status
     */
    public Status status() {
        return status;
    }

    /**
     * Returns the step command.
     *
     * @return step command
     */
    public String command() {
        return command;
    }


    @Override
    public String toString() {
        return name + SEP + time + SEP + status + SEP + command;
    }

    /**
     * Returns a record parsed from the specified string.
     *
     * @param string string encoding
     * @return step record
     */
    public static StepEvent fromString(String string) {
        String[] fields = string.split("~");
        return fields.length == 4 ?
                new StepEvent(fields[0], parseLong(fields[1]), valueOf(fields[2]),
                              fields[3].equals("null") ? null : fields[3]) :
                new StepEvent(fields[0], 0, Status.WAITING, null);
    }
}