How to use

Type

in

de.smartics.testdoc.core.doc

/**
 * {@inheritDoc}
 *
 * @see de.smartics.testdoc.report.index.ExportIndex#addToIndex(de.smartics.testdoc.core.doc.UnitTestDoc)
 */
@Override
public void addToIndex(final UnitTestDoc testDoc)
{
 final Type type = testDoc.getUutType();
 final String packageName = type.getPackageName();
 final Map<String, UnitTestDoc> nameIndex = getNameIndex(packageName);
 final String typeName = type.getTypeName();
 nameIndex.put(typeName, testDoc);
}

private String createFileName(final Type testCaseType)
{
 final String type = testCaseType.toString();
 return "TEST-" + type + ".xml";
}

/**
 * Convenience constructor.
 *
 * @param resultType the result type of the test case.
 * @param time the reported duration of the test case execution.
 * @param testCaseType
 * @param testMethodName the name of the test method.
 */
public JUnitTestMethodDoc(final ResultType resultType, final String time,
  final String testCaseType, final String testMethodName)
{
 this(resultType, time, new Type(testCaseType), testMethodName);
}

@Override
protected void renderTestDocTypeStart(final UnitTestDoc testDoc)
{
 final Type type = testDoc.getUutType();
 final String id = type.toString();
 final String name = type.getTypeName();
 sink.section3();
 helper.renderAnchor(id);
 sink.sectionTitle3();
 sink.text(name + " (" + type.getPackageName() + ')');
 sink.sectionTitle3_();
}

private void renderSections(final Section<UnitTestDoc> section,
  final int level)
{
 final String name = section.getName();
 final String sectionLabel = messages.getLabel(name);
 helper.renderSectionStart(level, sectionLabel);
 if (!section.containsSubSections())
 {
  helper.renderIndexTableStart();
  int counter = 1;
  for (final UnitTestDoc testDoc : section.getItems())
  {
   final Type type = testDoc.getUutType();
   final String label = type.getTypeName();
   final String id = type.toString();
   helper.renderIndexRow(counter, label, id);
   counter++;
  }
  helper.renderIndexTableEnd();
 }
 else
 {
  final int nextLevel = level + 1;
  for (final Section<UnitTestDoc> subSection : section.getSubSections())
  {
   renderSections(subSection, nextLevel);
  }
 }
 helper.renderSectionEnd(level);
}

/**
 * {@inheritDoc}
 *
 * @see de.smartics.testdoc.report.index.ExportIndex#addToIndex(de.smartics.testdoc.core.doc.UnitTestDoc)
 */
@Override
public void addToIndex(final UnitTestDoc testDoc)
{
 final Type type = testDoc.getUutType();
 final String typeName = type.getTypeName();
 index.put(typeName, testDoc);
}

@Override
protected void renderTestDocTypeStart(final UnitTestDoc testDoc)
{
 final Type type = testDoc.getUutType();
 final String id = type.toString();
 final String name = type.getTypeName();
 sink.section3();
 helper.renderAnchor(id);
 sink.sectionTitle3();
 sink.text(name + " (" + type.getPackageName() + ')');
 sink.sectionTitle3_();
}

private void renderSections(final Section<UnitTestDoc> section,
  final int level)
{
 final String name = section.getName();
 final String sectionLabel = messages.getLabel(name);
 helper.renderSectionStart(level, sectionLabel);
 if (!section.containsSubSections())
 {
  helper.renderIndexTableStart();
  int counter = 1;
  for (final UnitTestDoc testDoc : section.getItems())
  {
   final Type type = testDoc.getUutType();
   final String label = type.getTypeName();
   final String id = type.toString();
   helper.renderIndexRow(counter, label, id);
   counter++;
  }
  helper.renderIndexTableEnd();
 }
 else
 {
  final int nextLevel = level + 1;
  for (final Section<UnitTestDoc> subSection : section.getSubSections())
  {
   renderSections(subSection, nextLevel);
  }
 }
 helper.renderSectionEnd(level);
}

@Override
protected void renderTestCase(final ScenarioTestDoc scenario)
{
 if (informationFilter.isShowTestCase())
 {
  sink.tableCell();
  final Type testCase = scenario.getTestCaseType();
  sink.text(testCase.getTypeName());
  final ExternalReportReferences reportRefs = testDocHelper.getReports();
  final List<ExternalReport> reports = reportRefs.getTestCaseReports();
  if (!reports.isEmpty())
  {
   sink.text(": ");
   final ScenarioLinkRenderer linkRenderer =
     new ScenarioLinkRenderer(sink, messages, scenario);
   for (final ExternalReport report : reports)
   {
    linkRenderer.renderTestMethodLink(report);
   }
  }
  sink.tableCell_();
 }
}

private void writeType(final Type type) throws XMLStreamException
{
 final String packageName = type.getPackageName();
 if (StringUtils.isNotBlank(packageName))
 {
  writeElement("package", packageName);
 }
 writeElement("type", type.getTypeName());
}

@Override
protected void renderTestCase(final ScenarioTestDoc scenario)
{
 if (informationFilter.isShowTestCase())
 {
  sink.tableCell();
  final Type testCase = scenario.getTestCaseType();
  sink.text(testCase.getTypeName());
  final ExternalReportReferences reportRefs = testDocHelper.getReports();
  final List<ExternalReport> reports = reportRefs.getTestCaseReports();
  if (!reports.isEmpty())
  {
   sink.text(": ");
   final ScenarioLinkRenderer linkRenderer =
     new ScenarioLinkRenderer(sink, messages, scenario);
   for (final ExternalReport report : reports)
   {
    linkRenderer.renderTestMethodLink(report);
   }
  }
  sink.tableCell_();
 }
}

private void writeType(final Type type) throws XMLStreamException
{
 final String packageName = type.getPackageName();
 if (StringUtils.isNotBlank(packageName))
 {
  writeElement("package", packageName);
 }
 writeElement("type", type.getTypeName());
}

protected void renderReports(final Type type,
  final List<ExternalReport> reports, final TestMethodDoc testMethod)
 throws XMLStreamException
{
 if (!reports.isEmpty())
 {
  xmlWriter.writeStartElement(TESTDOC_NS, "reports");
  for (final ExternalReport report : reports)
  {
   xmlWriter.writeStartElement(TESTDOC_NS, "report");
   final String messageKey = report.getLabelKey();
   final String label = messages.getLabel(messageKey);
   writeElement("name", label);
   final String link =
     report.constructLink(type.getPackageName(), type.getTypeName(),
       testMethod);
   writeElement("link", link);
   xmlWriter.writeEndElement();
  }
  xmlWriter.writeEndElement();
 }
}

protected void renderReports(final Type type,
  final List<ExternalReport> reports, final TestMethodDoc testMethod)
 throws XMLStreamException
{
 if (!reports.isEmpty())
 {
  xmlWriter.writeStartElement(TESTDOC_NS, "reports");
  for (final ExternalReport report : reports)
  {
   xmlWriter.writeStartElement(TESTDOC_NS, "report");
   final String messageKey = report.getLabelKey();
   final String label = messages.getLabel(messageKey);
   writeElement("name", label);
   final String link =
     report.constructLink(type.getPackageName(), type.getTypeName(),
       testMethod);
   writeElement("link", link);
   xmlWriter.writeEndElement();
  }
  xmlWriter.writeEndElement();
 }
}

void renderTestMethodLink(final ExternalReport report)
{
 final String messageKey = report.getLabelKey();
 final Type type = getType();
 final String link =
   report.constructLink(type.getPackageName(), type.getTypeName(),
     getTestMethod());
 if (link != null)
 {
  sink.link(link);
  final String label = messages.getLabel(messageKey);
  sink.text(label);
  sink.link_();
 }
}

void renderTestMethodLink(final ExternalReport report)
{
 final String messageKey = report.getLabelKey();
 final Type type = getType();
 final String link =
   report.constructLink(type.getPackageName(), type.getTypeName(),
     getTestMethod());
 if (link != null)
 {
  sink.link(link);
  final String label = messages.getLabel(messageKey);
  sink.text(label);
  sink.link_();
 }
}