ReqIF Export, deprecated requirement breaks export

[SewerynRoznowski]

Description

Trying to export requirements into ReqIF format gives error:

The given key was not present in the dictionary

This happens only if there are deprecated requirements.

Steps to recreate:

• Create an empty model
• Create a requirement specification
• Create a requirement group
• Create two new requirements
• Export to ReqIF (Export will work fine)
• Deprecate one of the requirements
• Export to ReqIF (Export will return an error)

Configuration

Comet Version:

• Comet-IME 10.0.5
• Comet-IME 11.0.0-rc9

[samatstariongroup]

thanks for posting, we'll have a look @lxatstariongroup can you please take care of this?

[SewerynRoznowski]

This seems to be caused by

COMET-IME-Community-Edition/Requirements/ReqIFDal/ReqIFBuilder.cs

Lines 597 to 607 in 4899190

	foreach (var requirement in reqSpec.Requirement.Where(x => x.Group == requirementGroup))
	{
	var child = new SpecHierarchy
	{
	Identifier = Guid.NewGuid().ToString(),
	LastChange = DateTime.UtcNow,
	Object = this.requirementMap[requirement]
	};
	specHierarchy.Children.Add(child);
	}

This throws a key error since requirementMap contains only non-depricated requirements, the deprecated status gets checked here when populating the map:

COMET-IME-Community-Edition/Requirements/ReqIFDal/ReqIFBuilder.cs

Lines 340 to 348 in 4899190

	private void InstantiateRequirementSpecObject()
	{
	var requirements = this.exportedIteration.RequirementsSpecification.SelectMany(x => x.Requirement).Where(x => !x.IsDeprecated).ToList();
	foreach (var requirement in requirements)
	{
	this.requirementMap.Add(requirement, this.mapper.ToReqIfSpecObject(requirement, (SpecObjectType)this.specType[requirement]));
	}
	}

This looks like an oversight, since other places the keys are filtered for depricated requirements to prevent this issue, as seen here:

COMET-IME-Community-Edition/Requirements/ReqIFDal/ReqIFBuilder.cs

Lines 562 to 572 in 4899190

	foreach (var requirement in requirementSpecification.Requirement.Where(x => !x.IsDeprecated && x.Group == null))
	{
	var child = new SpecHierarchy
	{
	Identifier = Guid.NewGuid().ToString(),
	LastChange = DateTime.UtcNow,
	Object = this.requirementMap[requirement]
	};
	reqifSpecification.Children.Add(child);
	}

That being said is there a reason why depricated requirements are being filtered out and not exported out? Removing the checks for depricated status and populating requirementMap with all requirements seems to have fixed the issue for me.

[lxatstariongroup]

@SewerynRoznowski

Seems like there an IsDeprecated attribute is added to the ReqIf output in some cases.
I think the check for IsDeprecated should be removed everywhere or we add a setting whether to add deprecated items to the output or not.

The latter would be my preferred solution.
@samatstariongroup do you agree?

[samatstariongroup]

Agreed

[lxatstariongroup]

@SewerynRoznowski You can find a new version here: https://github.com/STARIONGROUP/COMET-IME-Community-Edition/releases/tag/11.0.0-rc10

Please notice the new export setting where you can indicate if you want deprecated things included in the export or not:

[SewerynRoznowski]

@lxatstariongroup Thank you