News

Navigation

Test Scribe – Developer Guide

Couple of days ago I wrote about How To Change Test Scribe Template since than I got plenty of emails on that subject asking me to supply more and more information about changing Test Scribe Template.

Many people thinks that:

“The output generated by Test Scribe is not customizable in this release.”

But this is not fully correct, you can change the Test Scribe template but this will require couple of hacks….. But possible

I recommend you to read the How To Change Test Scribe Template article to understand what need to be change and more about the tt files, controls the Test Scribe document.

Test Scribe Command List

Text

Add text to the Test Scribe document you need to use the SprText command:

SprText(“Hello World”)

To use built in string reference (table bellow) you need to call SprHost.Resources.GetString(Name)

SprText(SprHost.Resources.GetString("TestCaseLabel"))

SprText(“Section Name”, SprHost.Resources.GetString("TestCaseLabel"))

Using String.Format:

TestCasesLabel = Test Cases ({0})

SprText(String.Format(CultureInfo.CurrentCulture, SprHost.Resources.GetString("TestCasesLabel"), suite.AllTestCases.Count))

Hyperlink

Hyperlinks in Test Scribe are very powerful, you can add links that will activate MTM objects directly or just a simple hyperlink.

SprHyperlink(Text, Uri Value)

How to open Test Plan (In MTM) From the Word Document using the BuildUrl method:

SprHyperlink(TestPlan.Id.ToString(), BuildUrl("testing/testplan/open?id=" + TestPlan.Id.ToString()))

Result: mtm://localhost:8080/tfs/defaultcollection/p:TeamProject/testing/testplan/open?id=3

Images

Adding built in images or new images as follow:

SprImage("/Images/TestCase_16.png")

Paragraph

This is with no doubt the must popular method you will use when customizing the Test Scribe Template, Create new Paragraph.

Inside the paragraph you can use all the above methods.

SprParagraph
    (
        "Heading4",
        SprImage("/Images/TestCase_16.png"),
        SprText(SprHost.Resources.GetString("TestCaseLabel")),
        SprHyperlink(testCase.Id.ToString(), BuildUrl("testing/testcase/open?id=" +
        testCase.Id.ToString())),
        SprText(String.Format(CultureInfo.CurrentCulture, SprHost.Resources.GetString
        "ItemHeaderFmtString"), testCase.Title))
    );

Test Scribe Images Reference

There are set of images inside “Microsoft.TeamFoundation.TestManagement.Tools.TestScribe.dll”, you can add your own images inside the template.

Name	Value
Aborted_16
Blocked_16
Bug_16
Error_16
Failed_16
Inconclusive_16
InProgress_16
None_16
NotExecuted_16
Passed_16
Paused_16
Pending_16
Queued_16
RunComplete_16
RunInitializing_16
SharedStepSet_16
TestCase_16
TestConfiguration_16
TestConfiguration_32
TestPlan_16
TestPlan_32
TestSettings_16
TestSettings_32
TestStep_16
TestStepValidate_16
TestSuiteDynamic_16
TestSuiteRequirement_16
TestSuiteStatic_16
Timeout_16
Warning_16

Test Scribe String Reference

When customizing the Test Scribe template you can use the default values inside “Microsoft.TeamFoundation.TestManagement.Tools.TestScribe.dll” to avoid static text inside the tt file extension.

Name	Value
ActiveDatesLabel	Active dates:
AdditionalNotesHeaderLabel	Additional Notes
AreaLabel	Area:
AssignedToLabel	Assigned to:
AutomatedTestNameLabel	Automated test:
AutomatedTestRunLabel	Automated
AutomatedTestSettingsLabel	Automated Settings {0}: {1}
AutomatedTestType	Automated
BugLabel	Bug
BugsLoggedLabel	Bug(s) logged:
BuildDefinitionLabel	Build definition:
BuildLabel	Build:
BuildNumberLabel	Build(s):
BuildQualityLabel	Build quality:
BuildUnassignedLabel	Unassigned
CommaSeparator	{0}
CompletedWithIssues	completed with issues.
ConfigDetailsDescription	You can use one or more configuration variables to create a test configuration. Each configuration variable defines one characteristic of the testing environment. For example
ConfigurationDetailsHeaderLabel	Configuration Details
ConfigurationLabel	Config {0}: {1}
ControllerNoLongerExists	<Agent no longer exists>
DateRangeSeparator	-
DayFormatString	{0} day{1}{2}
DurationLabel	Duration:
EnterNotesHereLabel	<Enter notes here>
EnvironmentNoLongerExists	<Environment no longer exists>
ExpectedValueColumnHeader	Expected Value
Failed	failed.
FailedTestsByTypeChartLabel	Failed Tests by Type
FailureType_KnownIssue	Known issue
FailureType_KnownIssues	Known issues
FailureType_NewIssue	New issue
FailureType_NewIssues	New issues
FailureType_Regression	Regression
FailureType_Regressions	Regressions
FailureType_Unknown	Unknown
FailureTypeLabel	Failure type:
HourFormatString	{0} hour{1}{2}
IncludedRunsHeaderLabel	Included Runs ({0})
InProgress	in progress.
ItemHeaderFmtString	: {0}
IterationLabel	Iteration:
LocalOnlyEnvironmentName	<Local>
ManualTestRunLabel	Manual
ManualTestSettingsLabel	Manual Settings {0}: {1}
ManualTestType	Manual
MetadataLabelFormat	{0}:
MinuteFormatString	{0} minute{1}
NameValueSeparator	\|
NoBugsLinkedLabel	No bugs logged
NoBuildAssigned	<Not assigned>
NoControllerUsed	<No agent used>
NoResultsFoundLabel	No results found.
NotSetLabel	Not set
OtherTestResolutionName	{0} Others ({1}%)
Outcome_Unspecified	Active
OutcomeSummaryHeaderLabel	Outcome Summary
OwnerLabel	Owner:
Passed	passed successfully.
PlanState_Active	Active
PlanState_Inactive	Inactive
PriorityLabel	Priority:
RelatedBugsHeader	Related Bugs ({0})
ResultLabel	(result)
RunByLabel	Run by:
RunDateStartedLabel	Date started:
RunTypeLabel	Run type:
SecondFormatString	{0} second{1}
SingleTestRunSummaryHeader	Test run {0}: {1} {2}
State_Aborted	Aborted
State_Blocked	Blocked
State_Error	Error
State_Failed	Failed
State_Inconclusive	Inconclusive
State_None	None
State_NotExecuted	Not executed
State_NotStarted	Not started
State_Passed	Passed
State_Timeout	Timeout
State_Waiting	Waiting for Test Controller
State_Warning	Warning
StatisticFormatString	{0} {1} ({2}%)
StepNumberColumnHeader	#
SuiteDetailsDescription	You can group your test cases together by organizing test cases into a test suite hierarchy in your test plan. By grouping your test cases together
SuiteDetailsLabel	Suite Details
SuiteEntryLabel	Suite {0}: {1}
SuiteHierarchyLabel	Suite Hierarchy
SuiteState_Completed	Completed
SuiteState_InPlanning	In planning
SuiteState_InProgress	In progress
SuiteState_None	None
TestAnalysisByTypeChartLabel	Test Analysis by Type
TestCaseLabel	Test Case
TestCasesLabel	Test Cases ({0})
TestControllerLabel	Test controller:
TestEnvironmentLabel	Test environment:
TestOutcomeChartLabel	Test Outcome
TestPlanAvailableConfigsLabel	Available Configurations ({0})
TestPlanLabel	Test plan
TestPlanSectionDescription	A test plan lets you specify what you want to test and how to run those tests. A test plan can be applied to a specific iteration of your project. You can have just one default test suite for your test cases
TestPlanSectionDescription2	You can also select the default configurations to use to run the tests in your test plan. The test configuration informs the tester of the set up that is required for these tests. You can have one or multiple default configurations. A test result is recorded every time that you run the test with a specific configuration. A test plan enables you to measure your testing progress
TestPlanSectionText	Test Plan Details
TestPlanStatusLabel	Status:
TestPlanTestSettingsLabel	Test Settings
TestResolutionLabel	Test resolution:
TestRunDetails_BuildSummaryDisplay	{0} (Platform: {1}
TestRunLabel	Test Run
TestRunState_Aborted	aborted
TestRunState_Completed	completed
TestRunState_InProgress	in progress
TestRunState_NotStarted	not started
TestRunState_Waiting	waiting
TestRunSummaryHeader	{0} Test run{1} {2}
TestRunSummaryHeader_WithIssuesLabel	with issues
TestSettingsDetailsDescription	Test settings use diagnostic data adapters
TestSettingsDetailsHeaderLabel	Settings Details
TestSettingsLabel	Test settings:
TestStepsLabel	Test Steps ({0})
TestSuiteState	State:
TimespanInProgress	in progress
TimespanLabel	Timespan:
TitleColumnHeader	Title
TitleHeaderColumnHeader	Title
TypeLabel	Type:
TypeNone	{0} None ({1}%)
UnanalyzedFailuresByOwnerChartLabel	Unanalyzed Failures by Owner
UnassignedFailureHeaderLabel	Unanalyzed Failures ({0})

Posted: Oct 18 2011, 08:18 PM by shair | with 3 comment(s) |

תגים:.NET, TFS Utilities, Development, Work Items, Testing, PowerTools, TECH, DEV, Visual Studio 2010, How To, Team System 2010, Microsoft Test Manager, .NET 4, Test Scribe

Comments

Ryan said:

Great work figuring this out.

# October 19, 2011 3:56 AM

Hugo said:

How can show a customized field with SprText()? I've a customized field, e.g. named AAA, in the test case. And i add the line into TestCaseSection.tt,"SprText(SprHost.Resources.GetString("AAA"))", when i click generate, it shows "Compiling transformation: Argument missing".

# February 8, 2012 10:06 AM

Emil L said:

Is there a easy way to hide or remove fields, for exampel:

Available Configurations (1)

Config 6: TS1

Test Settings

Suite Hierarchy

Test (8)

When creating testcases that are going out to cusomer this information is not needed so would know if there is an easy way to change so it is not generated.

# March 20, 2012 11:32 AM

Shai Raiten's Blog

Recent Posts

Tags