Spira

https://spiradoc.inflectra.com
Admin
Spira is an integrated Application Lifecycle Management (ALM) and agile planning platform that...
Tokens:285,523
Snippets:3,877
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Spira xUnit Addon

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-xUnit-NodeJS

Install the library using npm. This command should be run in your project's root directory.

```bash
npm install spira-addons-xunit
```

--------------------------------

### RemoteLaunchX Console Output Example

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/RemoteLaunch-Guide

This is an example of the console output you can expect when running RemoteLaunchX, showing connection status, test run retrieval, and execution details.

```text
Starting RemoteLaunch\...\n\n========================\n\nServer URL: http://localhost/Spira\n\nServer Login: fredbloggs\n\nAutomation Host: MyHost1\n\nChecking License Key for: Inflectra Corporation\n\nProduction License Key in Use.\n\nTesting connection to Spira\...\n\nSuccessfully connected to Spira.\n\nWARNING: Unable to retrieve test runs for Spira project PR2, so\nskipping this project - Automation Host with token 'MyHost1' doesn't\nexist in projec PR2.\n\nWARNING: Unable to retrieve test runs for Spira project PR3, so\nskipping this project - Automation Host with token 'MyHost1' doesn't\nexist in projec PR3.\n\nRetrieved 1 test run(s) from Spira.\n\nExecuting test case TC18 with filename\n'C:\\Windows\\System32\\ipconfig.exe\|\/all'\n\nThis is a Linked test script\n\nExecuting command 'C:\\Windows\\System32\\ipconfig.exe' with arguments\n'/all'\n\n**Execution Status = Passed**\n\nExiting RemoteLaunch\...\n\n========================

```

--------------------------------

### NUnit Addins File Configuration

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-NUnit

Example content for the nunit.bundle.addins file after installing the Spira NUnit add-in. Ensure SpiraTestNUnitAddIn.dll is listed.

```text
addins/nunit.v2.driver.dll
addins/nunit-v2-result-writer.dll
addins/nunit-project-loader.dll
addins/vs-project-loader.dll
addins/teamcity-event-listener.dll
addins/SpiraTestNUnitAddIn.dll

```

--------------------------------

### Basic GET API Call Example

Source: https://spiradoc.inflectra.com/Developers/API-Overview

An example of a basic GET API call to retrieve user information from Spira. Ensure correct URL, username, API key, and headers are provided.

```HTTP
GET https://COMPANY.spiraservice.net/Services/v7_0/RestService.svc/users?username=administrator&api-key={XXXXXX-YYYY-4D29-ZZZZ-5E300XYZ0AC2}
content-type: application/json
Accept: application/json

{ body content }
```

--------------------------------

### QTP/UFT Test Execution Report Example

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/HP-UFT--QTP

This is an example of a detailed test report generated by QTP/UFT, showing test execution details, summary results, and step-by-step actions.

```text
QuickTest Professional                                                

Test: Test1                                                           

Results Name: Res21                                                   

Run Started: 10/22/2010 - 11:49:06                                    

Run Ended: 10/22/2010 - 11:49:10                                      

Summary Results                                                       

======= =======                                                       

Passed: 0                                                             

Failed: 0                                                             

Warnings: 0                                                           

Detailed Results                                                      

======= =======                                                       

Iteration: 1                                                          

=============

Action: Log In To Flight                                              

=============

Step: Login: Dialog                                                   

Step: Agent Name:.SetText: "Bobba Fett"                               

Step: Agent Name:.Type: "&lt__MicTab&gt"                            

Step: Password:.SetSecureText:                                        
"4cc08e88683135b35bb8a7dab8442c69b8441f3e"                            

Step: OK.Click:                                                       

Step: Flight Reservations: Dialog                                     

Step: OK.Click:                                                       


```

--------------------------------

### Spira Configuration File Example

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-xUnit-Python

This is an example of the spira.cfg file used to configure the Spira connection and map test cases and test sets. Ensure sensitive information like tokens are handled securely.

```ini
[credentials]
# Following are required
url = http://localhost/spira
username = administrator
token = {XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX}
project_id = 1
# Following are optional:
release_id = 5
test_set_id = 1
create_build = true

# Spira Test case for a specific classname.name
[test_cases]
LIS.Registration.registration1 = 2
LIS.Registration.registration2 = 3
LIS.Registration.registration3 = 4
LIS.Authentication.Login.login1 = 5
LIS.Authentication.Login.login2 = 9
LIS.Authentication.Login.login3 = 8
LIS.Authentication.auth1 = 6
LIS.Authentication.auth2 = 12
LIS.Authentication.auth3 = 13

LIS.Registration.registration4 = 5
LIS.Registration.registration5 = 9
LIS.Registration.registration6 = 8
LIS.Registration.registration7 = 6
LIS.Registration.registration8 = 12

# Spira Test sets for a specific name
# If not, the global value is used instead
[test_sets]
LIS.Registration = 2
LIS.Authentication = 5
LIS.Authentication.Login = 2

```

--------------------------------

### Sample NUnit Test Fixture

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-NUnit

A basic NUnit test fixture with SetUp and multiple Test methods, including examples that will succeed and fail.

```csharp
using NUnit.Framework;

namespace SampleTestSuite
{
    [TestFixture]
    class SampleTest
    {
        int One, Two;
        [SetUp]
        protected void SetUp()
        {
            One = 1;
            Two = 2;
        }
        [Test]
        public void TestAdd()
        {
            int Result = One + Two;
            //will succeed
            Assert.AreEqual(Result, 3);
        }
        [Test]
        public void TestMultiply()
        {
            int Result = One * Two;
            //will fail
            Assert.AreEqual(Result, 3);
        }
        [Test]
        public void TestConcat()
        {
            string Result = string.Concat(One, Two);
            //will fail
            Assert.AreEqual(Result, "21");
        }   
    }
}

```

--------------------------------

### Example Sync Mode and Parameter Combinations

Source: https://spiradoc.inflectra.com/External-Bug-Tracking-Integration/Using-SpiraTeam-with-Jira-Cloud

Illustrates how to combine sync modes with optional parameters for data synchronization between SpiraTeam and Jira.

```text
Bidirectional,NoAttachments
Complete,NoAttachments,createReleasesOnly
Default,NoAttachments (or just NoAttachments for default mode)
```

--------------------------------

### Example Spira Product Token

Source: https://spiradoc.inflectra.com/Build-Server-Integration/GitHub-Actions

An example of a Spira product token, '[PR:1]', which should be included in the GitHub repository description to establish the integration.

```Markdown
[PR:1]
```

--------------------------------

### Run RemoteLaunchX on Windows

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/RemoteLaunch-Guide

This is a sample Windows batch file to simplify the execution of RemoteLaunchX. Ensure Java 1.8 SE or later is installed.

```batch
@echo off
java -jar RemoteLaunchX.jar
```

--------------------------------

### PHPUnit Test Class Example

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PHPUnit

A basic PHPUnit test class demonstrating test methods and setup.

```php
<?php

/**
 * Using PHPUnit with Spira
 *
 * @author      Inflectra Corporation
 * @version     0
 *
 */

class SimpleTest extends PHPUnit_Framework_TestCase
{
    protected $fValue1;
    protected $fValue2;

    /**
     * Sets up the unit test
     */
    protected function setUp()
    {
        $this->fValue1= 2;
        $this->fValue2= 3;
    }

    /**
     * Tests the addition of the two values
     */
    public function testAdd__2()
    {
        $result = $this->fValue1 + $this->fValue2;

        // forced failure result == 5
        $this->assertTrue ($result == 6);
    }

    /**
     * Tests division by zero
     */
    /*
    public function testDivideByZero__3()
    {
        $zero = 0;
        $result = 8 / $zero;
        $result++; // avoid warning for not using result
    }

    /**
     * Tests two equal values
     */
    /*
public function testEquals__4()
    {
        $this->assertEquals(12, 12);
        $this->assertEquals(10, 10);
            $num1 = 12;
            $num2 = 12;
        $this->assertEquals($num1, $num2);

        $this->assertEquals("Size", 12, 13);
        $this->assertEquals("Capacity", 10, 199, 0);
    }

    /**
     * Tests success
     */
    /*
    public function testSuccess__5()
    {
        //Successful test
        $this->assertEquals(12, 12);
    }
}
?>

```

--------------------------------

### WebLOAD Script Execution Example

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/WebLOAD

An example of a successful WebLOAD script execution as reported back to Spira, showing the script file and arguments passed.

```text
Results from results.xml: Passed Test 
File Name: C:\Users\suzanne.bauer\Documents\WebLOAD\Sessions\input\WebLOADFirstTest.tpl
with arguments: C:\Users\su.be\Documents\WebLOAD\Sessions\output\WebLOADFirstTest20200228135424.ls /rc C:\Users\su.be\Documents\WebLOAD\Sessions\output\results.xml /ar 300 

```

--------------------------------

### Basic cypress.config.js Setup

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-Cypress

This is a basic configuration for a cypress.config.js file. It sets up Node events for logging.

```javascript
const { defineConfig } = require("cypress");

module.exports = defineConfig({
    e2e: {
        setupNodeEvents(on, config) {
        on('task', { 
            log(message) {
            console.log(message)
            return null
            },
        })
        },
    }
});


```

--------------------------------

### Install Spira Robot Framework Plugin

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-Robot-Framework

Install the latest version of the Spira plugin for Robot Framework using pip.

```bash
pip install spira-robot-framework
```

--------------------------------

### Example Filename for Attached Test

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/RemoteLaunch-Guide

Shows the filename format for an attached command-line test script. This example includes a special token for the filename itself.

```plaintext
C:\Temp\TestApp.exe|-arg1 -arg2 "-arg3=[Filename]"
```

--------------------------------

### Indenting Example for Requirements

Source: https://spiradoc.inflectra.com/Migration-and-Integration/Importing-from-Microsoft-Excel-%28Office365%29

Use '> ' at the start of the 'Name' field to create a child requirement. This example shows a hierarchical structure.

```text
Indenting Example:
Item 1
> Item 2 child of item 1
> Item 3 child of item 1
> > Item 4 child of item 3
```

--------------------------------

### Linking Squish Test Case with Parameters

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/Squish

Example of specifying a Squish test case path with configuration parameters for execution.

```bash
[ProgramFiles]\Froglogic\squish-4.0.1-web-win32\examples\web\suite_examples\tst_icefaces_addressbook_datadriven|--wrapper Web
```

--------------------------------

### SpiraApp Metadata Example

Source: https://spiradoc.inflectra.com/Developers/SpiraApps-Manifest

Provides essential information to identify and explain the SpiraApp. This section is mandatory.

```yaml
guid: 9cbb6a57-ffc1-4ff8-aef7-a740d6bd22b1
name: myFirstSpiraApp
caption: My first SpiraApp
summary: A hello world example SpiraApp
description: The aim of this SpiraApp is to show a basic hello world style proof of concept
productSummary: A hello world example SpiraApp
productDescription: The aim of this SpiraApp is to show a basic hello world style proof of concept
author: My Company
url: https://mycompany.com/help/spirapps/hello-world
icon: data:image/svg+xml;base64,file://myIcon.svg
license: MIT License
copyright: Copyright My Company
version: 0.2

```

--------------------------------

### Squish Test Execution Log Example

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/Squish

This log shows the output from a Squish test execution, including start times, test case names, and PASS/FAIL statuses.

```log
2010-11-02T16:50:01-04:00 START_TEST suite_examples                 

2010-11-02T16:50:01-04:00 START_TEST tst_icefaces_addressbook_datadriven                                

2010-11-02T16:50:05-04:00 PASS Comparison 'true' and 'true' are equal                                                                 

2010-11-02T16:50:25-04:00 PASS Verified True expression               

2010-11-02T16:50:30-04:00 PASS Verified True expression               

2010-11-02T16:50:32-04:00 PASS Comparison 'Reginald' and              
'Reginald' are equal                                                  

2010-11-02T16:50:33-04:00 PASS Comparison 'CA' and 'CA' are equal     

2010-11-02T16:50:40-04:00 PASS Comparison 'true' and 'true' are       
equal                                                                 

2010-11-02T16:50:59-04:00 PASS Verified True expression               

2010-11-02T16:51:09-04:00 PASS Verified True expression               

2010-11-02T16:51:12-04:00 PASS Comparison 'Tanja' and 'Tanja' are equal                                                                 

2010-11-02T16:51:12-04:00 PASS Comparison 'NY' and 'NY' are equal  

```

--------------------------------

### Parameterized Selenese Command Example

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/Selenium

Shows how to use Spira parameters within a Selenese command by referencing them with the ${parameterName} syntax.

```Selenese
open||${url}
```

--------------------------------

### Linking Squish Test Suite

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/Squish

Example of specifying a Squish test suite path for execution. Configuration parameters are typically included in the suite.conf file.

```bash
[ProgramFiles]\Froglogic\squish-4.0.1-web-win32\examples\web\suite_examples
```

--------------------------------

### Menu Configuration Example

Source: https://spiradoc.inflectra.com/Developers/SpiraApps-Manifest

Defines menu entries for a SpiraApp on a specific page. Each entry has a name, caption, tooltip, icon, and an action to perform when clicked.

```yaml
menus:
- pageId: 9
  caption: Analyze Requirement
  icon: fa-light fa-flask
  isActive: true
  entries:
  - name: readingLevelScore
    caption: Reading Level Grade
    tooltip: Get the reading level grade score for the requirement description
    icon: fa-light fa-graduation-cap
    isActive: true
    actionTypeId: 2
    action: scoreDescriptionGrade

```

--------------------------------

### Example GitHub Webhook URL

Source: https://spiradoc.inflectra.com/Build-Server-Integration/GitHub-Actions

An example of a fully constructed webhook URL for GitHub Actions integration with Spira, including a SpiraService.net base URL and a sample API key.

```URL
https://mysite.spiraservice.net/Services/Webhooks/BuildService.svc/GitHub?username=github-actions&api-key={11111111-1111-1111-1111-111111111111}
```

--------------------------------

### Sample PHPUnit Test Suite

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PHPUnit

A basic PHPUnit test suite setup that includes tests from a specified class and runs them, printing the results to the console.

```PHP
<?php
/**
 * 
 * @author      Inflectra Corporation
 * @version     0
 *
 */

 require_once 'PHPUnit/Framework.php';
 require_once 'PHPUnit/TextUI/ResultPrinter.php';
 require_once './SimpleTest.php';

 // Create a test suite that contains the tests
 // from the ArrayTest class
  $suite = new PHPUnit_Framework_TestSuite('SimpleTest');

 // Create a test result and attach the default console text listener
 $result = new PHPUnit_Framework_TestResult;
 $textPrinter = new PHPUnit_TextUI_ResultPrinter;
 $result->addListener($textPrinter);

 // Run the tests and print the results
 $result = $suite->run($result);
 $textPrinter->printResult($result);

 ?>
```

--------------------------------

### Complete Sample Selenium Test Script

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/Selenium

A comprehensive example of a Selenium test script written in Selenese, demonstrating various commands and the use of parameters.

```Selenese
open||http://www.google.com/webhp

assertTitle||Google

type||q||${query}

click||btnG

waitForPageToLoad||5000

isTextPresent||${matchtext}
```

--------------------------------

### Install IIS Web Server Role via PowerShell

Source: https://spiradoc.inflectra.com/Spira-Administration-Guide/Installing-SpiraPlan

Use this PowerShell command to install the Web Server (IIS) role on Windows Server 2012, 2016, or 2019.

```powershell
Install-WindowsFeature -name Web-Server -IncludeManagementTools
```

--------------------------------

### Spira Test Run Console Output Example

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-Robot-Framework

Example console output when successfully reporting test cases to Spira. This indicates the URL and the number of test cases reported.

```text
Sending test results to Spira at URL 'https://myserver/spiraservice.net'.
Successfully reported 4 test cases to Spira.

```

--------------------------------

### Sample PyUnit Test Fixture

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PyUnit

A typical PyUnit test fixture structure in Python, demonstrating test methods, setup, and assertions.

```python
import random
import unittest

# sample PyUnit test case
class TestSequenceFunctions(unittest.TestCase):
    def setUp(self):
        self.seq = range(10)

    def testshuffle(self):
        # make sure the shuffled sequence does not lose any elements
        random.shuffle(self.seq)
        self.seq.sort()
        self.assertEqual(self.seq, range(10))

    def testchoice(self):
        element = random.choice(self.seq)
        self.assert_(element in self.seq)

    def testfail(self):
        self.assertEqual(1, 2, "1==2 Should fail")

    def testsample(self):
        self.assertRaises(ValueError, random.sample, self.seq, 20)
        for element in random.sample(self.seq, 5):
            self.assert_(element in self.seq)

    suite = unittest.TestLoader().loadTestsFromTestCase(TestSequenceFunctions)
    testResult = unittest.TextTestRunner(verbosity=2).run(suite)

```

--------------------------------

### Example Test File Structure

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PyTest

A sample Python test file demonstrating various test functions and a test class. These tests can be mapped to SpiraTest cases.

```python
def test_login():
    # Maps to test case 40
    assert True

def test_logout():
    # Maps to test case 40
    assert True

class TestSecurity:
    def test_2fa(self):
        # Maps to test case 40
        assert True
```

--------------------------------

### PyTest Example with Spira Mappings

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PyTest

A comprehensive PyTest file demonstrating various mapping strategies: default, function-specific, marker-based, and explicit Spira ID markers.

```python
import pytest

# Function we are testing
def add(num1, num2):
    return num1 + num2

# Uses default mapping (20)
def test_add_1():
    assert add(1, 1) == 2

# Uses function mapping (22)
def test_add_2():
    assert add(2, 1) == 3

# Uses marker mapping (30)
@pytest.mark.smoke
def test_add_smoke():
    assert add(3, 3) == 6

# Uses explicit spira_id marker (100)
@pytest.mark.spira_id(100)
def test_add_special():
    assert add(4, 4) == 8

# All tests use class mapping (25)
class TestCalculator:
    def test_add(self):
        assert add(5, 5) == 10

    def test_subtract(self):
        assert 10 - 5 == 5

    # Override with explicit marker (200)
    @pytest.mark.spira_id(200)
    def test_multiply(self):
        assert 2 * 3 == 6

# All tests use regression marker (31)
@pytest.mark.regression
class TestRegression:
    def test_feature_a(self):
        assert True

    def test_feature_b(self):
        assert True
```

--------------------------------

### Create a Task using POST

Source: https://spiradoc.inflectra.com/Developers/API-Overview

Use POST requests to create new artifacts in Spira. This example demonstrates creating a new task with a name and status.

```HTTP
POST https://my-company.spiraservice.net/Services/v7_0/RestService.svc/projects/1/tasks?
content-type: application/json
Accept: application/json

{
    "Name": "My new task",
    "TaskStatusId": 1
}

```

--------------------------------

### Retrieve New Tasks with Pagination

Source: https://spiradoc.inflectra.com/Developers/API-Overview

Example of retrieving new tasks with pagination parameters. Adjust start_row and number_of_rows to manage data retrieval.

```HTTP
GET https://my-company.spiraservice.net/Services/v7_0/RestService.svc/projects/1/tasks/new?creation_date=2021-01-01T00:00:00.000&start_row=1&number_of_rows=10
```

```HTTP
GET https://my-company.spiraservice.net/Services/v7_0/RestService.svc/projects/1/tasks/new?creation_date=2021-01-01T00:00:00.000&start_row=11&number_of_rows=10
```

```HTTP
GET https://my-company.spiraservice.net/Services/v7_0/RestService.svc/projects/1/tasks/new?creation_date=2021-01-01T00:00:00.000&start_row=21&number_of_rows=10
```

--------------------------------

### xUnit Test Case with Properties and Attachments

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-xUnit-NodeJS

An example of a test case that includes custom properties, such as priority, language, author, and attachments, along with a descriptive text.

```xml
<testcase name="registration8" classname="LIS.Registration" assertions="4"
    time="1.625275" file="tests/registration.cs" line="302">
    <properties>
        <property name="priority" value="2 - High" />
        <property name="language" value="en-US" />
        <property name="author" value="Fred Bloggs" />
        <property name="attachment" value="screenshots/home.png" />
        <property name="attachment" value="screenshots/login.png" />
        <property name="description">
            This text describes the purpose of this test case and provides
            an overview of what the test does and how it works.
        </property>
    </properties>
</testcase>
```

--------------------------------

### Example Filename for Linked Test

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/RemoteLaunch-Guide

Illustrates the format for a filename when linking a command-line test script. It includes the path to the executable, arguments, and a mask for parameter conversion.

```plaintext
C:\Temp\TestApp.exe|-arg1 -arg2|-name=value
```

--------------------------------

### RFT Test Execution Log Example

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/Rational-Functional-Tester

This log shows the typical output from an RFT test execution, including script start/end times, warnings, failures, and exceptions.

```log
07-Nov-2011 03:00:05.004 PM: Script Start - INFORMATION - Script      
start [Script1]                                                     

07-Nov-2011 03:00:05.035 PM: Simplified Script Group - INFORMATION -  
firefox.exe: self improvement - QuickStart Tutorials for Rational     
Functional Tester (RFT) - Stack Overflow - Mozilla Firefox            

07-Nov-2011 03:00:05.035 PM: Timer Start - INFORMATION - Start timer: 
fir
e
f
o
x
e
s
e
l
f
i
m
p
r
o
v
e
m
e
n
tQ
u
i
c
kS
t
a
r
tT
u
t
o
r
i
a
l
sf
o
rR
a
t
i
o
n
a
l

F
u
n
c
t
i
o
n
a
l
T
e
s
t
e
r(R
F
T)

S
t
a
c
kO
v
e
r

M
o
z
i
l
l
aF
i
r
e
f
o
x


07-Nov-2011 03:00:25.535 PM: General - WARNING - Object Recognition   
is weak (above the warning threshold)                                 

07-Nov-2011 03:00:49.488 PM: General - FAIL - Script1.testMain had an 
unhandled exception.                                                  

07-Nov-2011 03:00:49.488 PM: Script End - FAIL - Script end           
[Script1]                                                           

Exception occurred during playback of script [Script1]              
[CRFCN0019E: RationalTestScriptException on line 49 of script        
Script1 - com.rational.test.ft.ObjectNotFoundException: CRFCN0661W:   
The recognition score of the found object does not qualify the object 
as a match.                                                           

Looking for [GuiSubitemTestObject(Name: goToAWebSitetext, Map:       
GoToAWebSite)], best failing candidate score was [22500] with best 
failing description [{.class=.Text, .name=Go to a Web Site,          
.classIndex=0}].                                                  


```

--------------------------------

### Retrieve a Task using GET

Source: https://spiradoc.inflectra.com/Developers/API-Overview

Use GET requests to retrieve specific artifacts from Spira. This example shows how to fetch a task by its ID from a given project.

```HTTP
GET https://my-company.spiraservice.net/Services/v7_0/RestService.svc/projects/1/tasks/2?
Accept: application/json

```

--------------------------------

### Query Examples with Project Tokens

Source: https://spiradoc.inflectra.com/Spira-Administration-Guide/System-Reporting

Demonstrates how to use special tokens to filter report data by ProjectId, ProjectGroupId, or to include all system data. Using these tokens is crucial for data security and relevance.

```SQL
select value R from SpiraTestEntities.R_Requirements as R where R.PROJECT_ID = ${ProjectId}
```

```SQL
select value R from SpiraTestEntities.R_Requirements as R where R.PROJECT_GROUP_ID = ${ProjectGroupId}
```

```SQL
select value R from SpiraTestEntities.R_Requirements as R
```

--------------------------------

### Run RemoteLaunchX on UNIX/Linux/MacOS X

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/RemoteLaunch-Guide

This is a sample shell script for running RemoteLaunchX on UNIX, Linux, or Mac OS X systems. It requires Java 1.8 SE or later.

```shell
#!/bin/sh
java -jar RemoteLaunchX.jar
```

--------------------------------

### Ranorex Test Execution Log Example

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/Ranorex

This log shows the detailed output from a Ranorex test execution, including start and end times, statuses of test suites and cases, and validation messages. It helps in diagnosing failures.

```text
+-----------------------------------------------------------------------+
| [2011/10/14 14:08:32.795][Debug ][Logger]: Console logger       |
| starting.                                                             |
|                                                                       |
| [2011/10/14 14:08:32.874][Info ][Test]: Test Suite 'WinForms    |
| Test' started.                                                        |
|                                                                       |
| [2011/10/14 14:08:32.889][Info ][Test]: Test Case               |
| 'VS2005_Application_Test' started.                                  |
|                                                                       |
| [2011/10/14 14:08:33.467][Success][Test]: Test Module           |
| 'StartWinformsSample' completed with status 'Success'.                |
|                                                                       |
| [2011/10/14 14:08:33.467][Info ][Test]: Test Module             |
| 'CheckIfApplicationAlive' started.                                    |
|                                                                       |
| [2011/10/14 14:08:33.608][Info ][Validation]: Validating Exists |
| on item 'WinFormsApp.ButtonTest_PushButton'.                          |
|                                                                       |
| [2011/10/14 14:09:55.718][Failure][Test]: Test Case             |
| 'VS2005_Application_Test' completed with status 'Failed'.           |
|                                                                       |
| [2011/10/14 14:09:55.718][Failure][Test]: Test Suite 'WinForms  |
| Test' completed with status 'Failed'.                                 |
+-----------------------------------------------------------------------+
```

--------------------------------

### Combine .env.spira and spira.cfg for Configuration

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PyTest

Recommended approach for best security and flexibility: use .env.spira for credentials and spira.cfg for test mappings. The [credentials] section is not needed in spira.cfg when using .env.spira.

```dotenv
# Credentials - DO NOT commit to git
SPIRA_URL=http://localhost/Spira
SPIRA_USERNAME=fredbloggs
SPIRA_TOKEN={XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXX}
SPIRA_PROJECT_ID=1
SPIRA_RELEASE_ID=5
SPIRA_TEST_SET_ID=1

```

```ini
# No [credentials] section needed when using .env.spira!

[test_cases]
# Default test case ID for unmapped tests (optional)
default = 20

# Function-level mapping
test_add_2 = 22

# Class-level mapping (all tests in class use this ID)
testcalculator = 25

[markers]

```

--------------------------------

### Basic JUnit 5 Test Fixture in Java

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-JUnit

A standard JUnit 5 test class structure in Java. It includes setup methods annotated with @BeforeEach and test methods annotated with @Test, along with various assertion examples.

```java
package com.inflectra.spiratest.addons.junitextension.samples;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;


/**
 * Some simple tests using the ability to return results back to Spira
 *
 * @author Inflectra Corporation
 * @version 4.0.0
 */
public class SimpleTest {
    protected int fValue1;
    protected int fValue2;

    /**
     * Sets up the unit test
     */
    @BeforeEach
    public void setUp() {
        fValue1 = 2;
        fValue2 = 3;
    }

    /**
     * Tests the addition of the two values
     */
    @Test
    public void testAdd() {
        double result = fValue1 + fValue2;

        // forced failure result == 5
        assertTrue(result == 6);
    }

    /**
     * Tests division by zero
     */
    @Test
    public void testDivideByZero() {
        int zero = 0;
        int result = 8 / zero;
    }

    /**
     * Tests two equal values
     */
    @Test
    public void testEquals() {
        assertEquals(12, 12);
        assertEquals(12L, 12L);
        assertEquals(new Long(12), new Long(12));

        assertEquals(12, 13, "Size");
        assertEquals(12.0, 11.99, 0.0, "Capacity");
    }

    /**
     * Tests success
     */
    @Test
    public void testSuccess() {
        //Successful test         assertEquals(12, 12);
    }
}

```

--------------------------------

### Install pytest-spiratest Plugin

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PyTest

Install the latest version of the Spira plugin for pytest using pip. Ensure you have Python (with pip) and pytest version 3.0 or later installed.

```bash
pip install pytest-spiratest
```

--------------------------------

### SpiraApp Setting Groups Example

Source: https://spiradoc.inflectra.com/Developers/SpiraApps-Manifest

Organizes system or product level administration settings into visually distinct groups. Each group requires a unique name and a user-friendly caption.

```yaml
settingGroups:
  - name: groupAlpha
    caption: First Group
  - name: groupBravo
    caption: Second Group

```

--------------------------------

### Execute Test Set via Command Line

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/SoapUI

Use this command to trigger immediate execution of a specific test set using RemoteLaunch. Ensure RemoteLaunch.exe is in your system's PATH or provide the full path.

```bash
RemoteLaunch.exe --testset:18
```

--------------------------------

### Example Raw XML Report Data

Source: https://spiradoc.inflectra.com/Spira-Administration-Guide/System-Reporting

This is an example of the raw XML data generated for a report section. It includes product and requirement details.

```xml
“?xml version="1.0" encoding="UTF-8" standalone="yes"?”
“Report”
  “Title”
    Requirements Detailed Report   “/Title”
  “ProductData”
    “Product”
      “ProjectId”1”/ProjectId”
      “ProjectGroupId”2”/ProjectGroupId”
      “Name”Library Information System”/Name”
      “Description”Sample application that allows users to manage books, authors and lending records for a typical branch library”/Description”
      “Website”www.libraryinformationsystem.org”/Website”
      “CreationDate”2005-11-30T19:00:00”/CreationDate”
      “ActiveYn”Y”/ActiveYn”
      “WorkingHours”8”/WorkingHours”
      “WorkingDays”5”/WorkingDays”
      “NonWorkingHours”0”/NonWorkingHours”
      “TimeTrackIncidentsYn”Y”/TimeTrackIncidentsYn”
      “TimeTrackTasksYn”Y”/TimeTrackTasksYn”
      “EffortIncidentsYn”Y”/EffortIncidentsYn”
      “EffortTasksYn”Y”/EffortTasksYn”
      “TasksAutoCreateYn”Y”/TasksAutoCreateYn”
      “ReqDefaultEffort”480”/ReqDefaultEffort”
      “TaskDefaultEffort”360”/TaskDefaultEffort”
      “ProductGroupName”Internal Products”/ProductGroupName”
    “/Product”
  “/ProductData”
  “RequirementData”
    “Requirement”
      “RequirementId”1”/RequirementId”
      “ProjectId”1”/ProjectId”
      “ScopeLevelId”3”/ScopeLevelId”
      “AuthorId”2”/AuthorId”
      “Name”Functional System Requirements”/Name”
      “CreationDate”2003-11-30T19:00:00”/CreationDate”
      “LastUpdateDate”2003-11-30T19:00:00”/LastUpdateDate”
      “IndentLevel”AAA”/IndentLevel”
      “ExpandedYn”Y”/ExpandedYn”
      “VisibleYn”Y”/VisibleYn”
      “SummaryYn”Y”/SummaryYn”
      “AttachmentsYn”N”/AttachmentsYn”
      “CoverageCountTotal”21”/CoverageCountTotal”
      “CoverageCountPassed”10”/CoverageCountPassed”
      “CoverageCountFailed”3”/CoverageCountFailed”
      “CoverageCountCaution”1”/CoverageCountCaution”
      “CoverageCountBlocked”1”/CoverageCountBlocked”
      “PlannedEffort”8700”/PlannedEffort”
      “TaskEstimatedEffort”11400”/TaskEstimatedEffort”
      “TaskActualEffort”7570”/TaskActualEffort”
      “TaskProjectedEffort”3855”/TaskProjectedEffort”
      “TaskRemainingEffort”11485”/TaskRemainingEffort”
      “TaskCount”42”/TaskCount”
      “TaskPercentOnTime”59”/TaskPercentOnTime”

```

--------------------------------

### Run TestNG Tests from Command Line

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-TestNG

Use this command to compile and run TestNG tests with the SpiraTest listener. Ensure the SpiraTestListener.jar and TestNG JARs are in the classpath.

```bash
-classpath "C:\Program
Files\SpiraTestListener\TestNGListener.jar;C:\Program
Files\TestNG-5.7\testng-5.7\testng-5.7-jdk15.jar" org.testng.TestNG
-listener
com.inflectra.spiratest.addons.testnglistener.SpiraTestListener
com
inflectra
spiratest
addons
testnglistener
samples
unittests.xml

```

--------------------------------

### Example Task Preset Configuration

Source: https://spiradoc.inflectra.com/SpiraApps/Task-Test-Presets

Defines a task preset named 'Development Checklist' with four tasks. One task, 'Write Test Cases', is explicitly assigned the type 'Testing', while the others will use the default task type.

```plaintext
Development Checklist:Design Screen,Develop Screen,Write Test Cases|Testing,Update Documentation
```

--------------------------------

### Spira Aggregated Result Example

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PyTest

An example of how test results from a PyTest module are aggregated and displayed in SpiraTest, showing overall status and individual test outcomes.

```text
Module: tests.features.authentication.test_login
Total: 3 tests - Passed: 3, Failed: 0, Skipped: 0

[PASSED] test_login
[PASSED] test_logout
[PASSED] TestSecurity.test_2fa
```

--------------------------------

### Product Admin Settings Example

Source: https://spiradoc.inflectra.com/Developers/SpiraApps-Manifest

Defines product-level settings unique to a specific product, used for Product Home Page widgets, artifact pages, or secure string storage. Only non-secure settings are accessible client-side.

```yaml
productSettings:
  - settingTypeId: 3 
    name: customProperty1
    caption: Select a release custom property
    artifactTypeId: 1
    position: 1
    tooltip: Please select a requirement custom property from the dropdown list
    settingGroup: groupAlpha

```

--------------------------------

### RemoteLaunchX Application Output

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/RemoteLaunch-Guide

This is the expected console output when RemoteLaunchX is executed. It shows connection status, license information, and any warnings related to test runs or host configuration.

```text
Starting RemoteLaunch\ ...

========================

Server URL: http://localhost/Spira

Server Login: fredbloggs

Automation Host: MyHost1

Checking License Key for: Inflectra Corporation

Production License Key in Use.

Testing connection to Spira\ ...

Successfully connected to Spira.

WARNING: Unable to retrieve test runs for Spira project PR2, so
skipping this project - Automation Host with token 'MyHost1' doesn't
exist in project PR2.

WARNING: Unable to retrieve test runs for Spira project PR3, so
skipping this project - Automation Host with token 'MyHost1' doesn't
exist in project PR3.

**Retrieved 0 test run(s) from Spira.**

Exiting RemoteLaunch\ ...

========================

```

--------------------------------

### Example CircleCI Webhook URL

Source: https://spiradoc.inflectra.com/Build-Server-Integration/CircleCI-Pipelines

An example of a complete webhook URL for CircleCI integration with Spira, including a sample base URL, service endpoint, username, and API key.

```URL
https://mysite.spiraservice.net/Services/Webhooks/BuildService.svc/CircleCI?username=circleci-pipelines&api-key={11111111-1111-1111-1111-111111111111}
```

--------------------------------

### SpiraApp Manifest - Basic Information

Source: https://spiradoc.inflectra.com/Developers/SpiraApps-Tutorial

Defines the core information about your SpiraApp, including its unique identifier, name, version, and author. Ensure the 'guid' is a newly generated GUID for uniqueness.

```yaml
guid: 00000000-0000-0000-0000-000000000000
name: myFirstSpiraApp
caption: My first SpiraApp
summary: A Tutorial SpiraApp
description: The aim of this SpiraApp is to show off multiple functionalities of SpiraApps
productSummary: A Tutorial SpiraApp
productDescription: The aim of this SpiraApp is to show off multiple functionalities of SpiraApps
author: My Company
url: https://mycompany.com/help/spiraapps/tutorial
license: MIT License
copyright: Copyright Inflectra
version: 1.0
```

--------------------------------

### FROM Clause Example

Source: https://spiradoc.inflectra.com/Reporting/Understanding-Entity-SQL

Specify the primary object collection and an alias to reference its properties in the query.

```sql
from SpiraTestEntities.R_Requirements as RQ
```

--------------------------------

### Spira API DateTime Formats

Source: https://spiradoc.inflectra.com/Developers/API-Overview

Example of ISO 8601 format for dateTime fields in the Spira API.

```json
    "StartDate":"2024-04-30T19:15:02.533Z",
    "EndDate":"2024-08-22T22:34:57.533Z"
```

--------------------------------

### Sample Perl TAP Test Fixture

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-Perl-TAP

An example of a Perl test file using Test::More for assertions.

```perl
#!/usr/bin/perl -w
# Specify our plan, how many tests we're writing
use Test::More tests => 9;
# or alternately, if we don't know how many:
# use Test::More qw(no_plan);
# Check that our module compiles and can be "use"d.
BEGIN { use_ok( 'Inflectra::SpiraTest::Addons::Samples::TestMe' );
}
# Check our module can be required. Very similar test to that above.
require_ok( 'Inflectra::SpiraTest::Addons::Samples::TestMe' );
# There are a number of ways to generate the "ok" tests. These are:
# ok: first argument is true, second argument is name of test.
# is: first argument equals (eq) second argument, third argument is
name of test.
# isnt: first argument does not equal (ne) the second, third is name
of test
# like: first argument matches regexp in second, third is name of
test
# unlike: first argument does not match regexp, third is name of test
# cmp_ok: compares first and third argument with comparison in
second. Forth is test name.
# Here are some examples that should PASS
ok( add(1,1) == 2, "Basic addition is working");
is ( subtract(2,1), 1, "Basic subtraction is working");
isnt( multiply(2,2), 5, "Basic multiplication doesn't fail");
# Here are some examples that should FAIL
ok( add(1,1) == 3, "Basic addition is working");
is ( subtract(2,1), 0, "Basic subtraction is working");
isnt( multiply(2,2), 4, "Basic multiplication doesn't fail");
# Here is an example of a test that throws an ERROR
is($notdeclared, 1, "Undeclared variable test");

```

--------------------------------

### SQL-Style Aggregate Example

Source: https://spiradoc.inflectra.com/Reporting/Understanding-Entity-SQL

Shows a SQL-style aggregate function in Entity SQL, which requires a GROUP BY clause.

```sql
SELECT a, sum(t.b) FROM T AS t GROUP BY t.a AS a
```

--------------------------------

### Executing RemoteLaunchX JAR

Source: https://spiradoc.inflectra.com/RemoteLaunch-User-Guide/RemoteLaunch-Guide

This command executes the RemoteLaunchX console application by running its JAR file directly. Ensure the JAR file is in the current directory or provide the full path.

```bash
Java --jar RemoteLaunchX.jar

```

--------------------------------

### Prompt to Generate Source Code

Source: https://spiradoc.inflectra.com/SpiraApps/AWS-Bedrock

Use this prompt to generate sample source code in a specified programming language. The output will be a JSON object containing the filename and the source code as an escaped string.

```text
You are a programmer working in the [CODE_LANGUAGE] programming language. Write sample code that implements the following feature in the following format { "Filename": [filename for source code], "Code": [source code in plain text as a single escaped string] }
```

--------------------------------

### Dashboard Widget Configuration Example

Source: https://spiradoc.inflectra.com/Developers/SpiraApps-Manifest

Sets up a SpiraApp to run as a custom widget on a dashboard page. Includes dashboard type ID, widget name, description, and the JavaScript file for the widget's functionality.

```yaml
dashboards:
  - dashboardTypeId: 1
    name: My Widget
    isActive: true
    description: A hello world example widget
    code: file://widget.js

```

--------------------------------

### Prompt to Generate Test Steps

Source: https://spiradoc.inflectra.com/SpiraApps/AWS-Bedrock

Use this prompt to generate at least 10 test steps for a given test case. The output will be a JSON object with a 'TestSteps' array, including description, expected result, and sample data for each step.

```text
Write at least 10 test steps for the following test case as { "TestSteps": [] }. For each test step include the description, expected result, and sample data in the following format { "Description": [Description of test step], "ExpectedResult": [The expected result], "SampleData": [Sample data in plain text] }
```

--------------------------------

### Filter by String Value

Source: https://spiradoc.inflectra.com/Developers/API-Overview

Example of filtering by a string value for substring match (case-insensitive). For boolean fields, use 'Y' or 'N'.

```json
[{ "PropertyName": "Name", "StringValue": "login error" }]
```

--------------------------------

### System Admin Settings Example

Source: https://spiradoc.inflectra.com/Developers/SpiraApps-Manifest

Defines system-level settings for a SpiraApp, such as secure credentials or user-facing display options for My Page widgets. Settings are stored securely and are not exposed to the browser.

```yaml
settings:
  - settingTypeId: 1 
    name: rowsToDisplay
    caption: How many rows should we display on the My Page widget?
    isSecure: false
    placeholder: 5
    position: 1
    tooltip: By default 5 rows are displayed
    settingGroup: groupAlpha

```

--------------------------------

### Get Complex Conjugate

Source: https://spiradoc.inflectra.com/Spira-User-Manual/Document-Management

Returns the complex conjugate of a complex number in 'x + yi' or 'x + yj' format.

```Spira Functions
=IMCONJUGATE(inumber)
```

--------------------------------

### DateTime Literal in Entity SQL

Source: https://spiradoc.inflectra.com/Reporting/Understanding-Entity-SQL

Provides an example of a DateTime literal in Entity SQL, where both date and time parts are mandatory.

```sql
DATETIME '2006-12-25 01:01:00.000'
```

--------------------------------

### Filter by Single Integer Value

Source: https://spiradoc.inflectra.com/Developers/API-Overview

Example of filtering a lookup field by a single integer ID. Use -999 to filter for NULL.

```json
[{ "PropertyName": "ReleaseId", "IntValue": 82 }]
```

--------------------------------

### Instantiate Spira Listener with Constructor Arguments

Source: https://spiradoc.inflectra.com/Unit-Testing-Integration/Integrating-with-PHPUnit

Create a new Spira listener instance and specify the connection information as constructor arguments.

```php
//Create a new Spira listener instance and specify the connection info
 $spiraListener = new SpiraListener_Listener (
'http://localhost/Spira',
    'fredbloggs',
 'fredbloggs',
    1,
    1,
    1);

```

--------------------------------

### Prompt to Generate Source Code with Unit Tests

Source: https://spiradoc.inflectra.com/SpiraApps/AWS-Bedrock

Use this prompt to generate sample source code along with unit tests in a specified programming language and test framework. The output will be a JSON object containing the filename and the source code as an escaped string.

```text
You are a programmer working in the [CODE_LANGUAGE] programming language. Could you write a sample unit test for the following feature using [CODE_LANGUAGE] and the [TEST_FRAMEWORK] framework in the following format { "Filename": [filename for source code], "Code": [source code in plain text as a single escaped string] }
```

--------------------------------

### Collection-Based Aggregate Example

Source: https://spiradoc.inflectra.com/Reporting/Understanding-Entity-SQL

Demonstrates using a collection-based aggregate function in Entity SQL. This operates on collections and does not require a GROUP BY clause.

```sql
SELECT t.a AS a, count({1,2,3}) AS b FROM T AS t
```
Tokens:
Raw