001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * SonarQube is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.test;
021
022import javax.annotation.Nullable;
023
024public interface TestCase {
025  enum Status {
026    OK, FAILURE, ERROR, SKIPPED;
027
028    public static Status of(@Nullable String s) {
029      return s == null ? null : valueOf(s.toUpperCase());
030    }
031  }
032
033  String TYPE_UNIT = "UNIT";
034  String TYPE_INTEGRATION = "INTEGRATION";
035
036  /**
037   * Duration in milliseconds
038   */
039  Long durationInMs();
040
041  String type();
042
043  Status status();
044
045  String name();
046
047  String message();
048
049  String stackTrace();
050
051  TestPlan testPlan();
052
053  boolean doesCover();
054
055  int countCoveredLines();
056
057  Iterable<CoverageBlock> coverageBlocks();
058
059  CoverageBlock coverageBlock(Testable testable);
060}