qadevOOo/runner/lib/Status.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 package lib;
  20
  21 /**
  22  * Status represents a result of a testing activity performed. The result is
  23  * described in two ways: state and runtime state. The state describes if the
  24  * activity was successful (OK state) or not (FAILED state). The runtime state
  25  * describes what happened during the activity: the test can be:
  26  *   - COMPLETED - the activity completed normally (although it can complete with
  27  *     FAILED state)
  28  *   - SKIPPED - the activity was not performed because of a reason (it also can
  29  *     has OK or FAILED state)
  30  *   - EXCEPTION - the activity was abnormally terminated because of an
  31  *     unexpected exception. It always has a FAILED state.
  32  *   - EXCLUDED - the activity is expected to fail. The state represents how
  33  *     the state really completed: OK or FAILED.
  34  *   - other variants are not formalized now and can be represented by
  35  *     Status.failed() method. They always have a FAILED state.
  36  */
  37 public class Status extends SimpleStatus {
  38
  39     /**
  40      * Construct a status: use runState and state
  41      * @param runState either COMPLETED, SKIPPED, etc.
  42      * @param bSuccessful OK or FAILED.
  43      */
  44     public Status(RunState runState, boolean bSuccessful ) {
  45         super(runState, bSuccessful);
  46     }
  47
  48     /**
  49      * Construct a status: use own message and state.
  50      * @param message An own message for the status.
  51      * @param bSuccessful OK or FAILED.
  52      */
  53     public Status(String message, boolean state) {
  54         super( message, state );
  55     }
  56
  57     /**
  58      * This is a factory method for creating a Status representing normal
  59      * activity termination.
  60      *
  61      * @param bSuccessful describes a test state (OK if state == true, FAILED
  62      * otherwise).
  63      */
  64     public static Status passed( boolean bSuccessful ) {
  65         return new Status(RunState.COMPLETED, bSuccessful );
  66     }
  67
  68     /**
  69      * This is a factory method for creating a Status representing an exception
  70      * activity termination. The Status always has FAILED state.
  71      *
  72      * @param t the exception with that the activity completed.
  73      */
  74     public static Status exception( Throwable t ) {
  75         return new ExceptionStatus( t );
  76     }
  77
  78     /**
  79      * This is a factory method for creating a Status representing a skipped
  80      * activity.
  81      *
  82      * @param state describes a test state (OK if state == true, FAILED
  83      * otherwise).
  84      */
  85     public static Status skipped( boolean bSuccessful ) {
  86         return new Status( RunState.SKIPPED, bSuccessful );
  87     }
  88
  89
  90
  91     /**
  92      * Creates a Status representing an activity failed for an arbitrary reason.
  93      * It always has FAILED state.
  94      *
  95      * @param reason describes why the activity failed
  96      */
  97     public static Status failed(final String reason) {
  98         return new Status(reason, false/*bSuccessful*/);
  99     }
 100
 101     /**
 102      * The method returns a human-readable description of the status.
 103      * The Status implementation of the method returns the status state
 104      * description and appends to it the reason, for example:
 105      * "FAILED.The getLabel works wrong", "COMPLETED.OK".
 106      */
 107     @Override
 108     public String toString() {
 109         String str = getRunStateString() + "." + getStateString();
 110
 111         return str;
 112     }
 113
 114     /**
 115      * Checks whether the status runstate is completed.
 116      */
 117     public boolean isCompleted() {
 118         return getRunState() == RunState.COMPLETED;
 119     }
 120
 121     /**
 122      * Checks whether the status state is failed.
 123      */
 124     public boolean isFailed() {
 125         return !isSuccessful();
 126     }
 127
 128 }