Skip to content

Add basic picture tests to ConfiguredXHTMLClassifiedTests #977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aror92 merged 1 commit into from
Jun 30, 2026
Merged

Add basic picture tests to ConfiguredXHTMLClassifiedTests #977

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 128 additions & 2 deletions Src/xWorks/xWorksTests/ConfiguredXHTMLGeneratorClassifiedTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ private ConfiguredLcmGenerator.GeneratorSettings DefaultSettings
private const string senseXpath = senseContentXpath + "/span[@class='sense']";
private const string headwordXpath = senseXpath + "/span[@class='headword-classified']";
private const string definitionXpath = senseXpath + "/span[@class='definitionorgloss']";
private const string picturesXpath = senseXpath + "/span[@class='pictures']";

[OneTimeSetUp]
public override void FixtureSetup()
Expand Down Expand Up @@ -171,10 +172,10 @@ private ILexSense CreateEntryWithSense(string headword, string gloss, bool addSu
}

/// <summary>
/// Builds the configuration for semantic domain with senses, optionally including grammatical info
/// Builds the configuration for semantic domain with senses, optionally including subsenses, grammatical info, or pictures
/// </summary>
private static ConfigurableDictionaryNode BuildSemanticDomainConfig(bool includeSubsenses = false,
bool includeGrammaticalInfo = false, bool numberSingleSense = false)
bool includeGrammaticalInfo = false, bool numberSingleSense = false, bool includePictures = false)
{
var abbrNode = new ConfigurableDictionaryNode
{
Expand Down Expand Up @@ -224,6 +225,27 @@ private static ConfigurableDictionaryNode BuildSemanticDomainConfig(bool include

senseChildren.Add(glossNode);


if (includePictures)
{
var thumbNailNode = new ConfigurableDictionaryNode { FieldDescription = "PictureFileRA", CSSClassNameOverride = "photo" };
var captionNode = new ConfigurableDictionaryNode { FieldDescription = "Caption", DictionaryNodeOptions = CXGTests.GetWsOptionsForLanguages(new[] { "analysis" }) };

var captionOrHeadwordNode = new ConfigurableDictionaryNode
{
FieldDescription = "CaptionOrHeadword",
DictionaryNodeOptions = CXGTests.GetWsOptionsForLanguages(new[] { "analysis" })
};
var pictureNode = new ConfigurableDictionaryNode
{
DictionaryNodeOptions = new DictionaryNodePictureOptions(),
FieldDescription = "PicturesOS",
CSSClassNameOverride = "Pictures",
Children = new List<ConfigurableDictionaryNode> { thumbNailNode, captionNode, captionOrHeadwordNode }
};
senseChildren.Add(pictureNode);
}

// Add subsense node if requested
if (includeSubsenses)
{
Expand Down Expand Up @@ -467,6 +489,110 @@ public void GenerateXHTMLForSemanticDomain_GramInfoBeforeSenseNumber_WhenOnlySec
AssertThatXmlIn.String(result).HasSpecifiedNumberOfMatchesForXpath(glossXpath, 1);
}

[Test]
public void GenerateXHTMLForSemanticDomain_OneSenseWithSinglePicture()
{
// Create semantic domain
var domain = Cache.ServiceLocator.GetInstance<ICmSemanticDomainFactory>().Create();
Cache.LangProject.SemanticDomainListOA.PossibilitiesOS.Add(domain);

// Create entry and sense
var testEntry = CXGTests.CreateInterestingLexEntry(Cache);
var sense = testEntry.SensesOS[0];

// Add picture to sense
sense.PicturesOS.Add(CXGTests.CreatePicture(Cache, true, "captionEn", "en"));
sense.PicturesOS[0].Caption.set_String(m_wsEn, TsStringUtils.MakeString("captionEn", m_wsEn));

// Associate semantic domain with sense
sense.SemanticDomainsRC.Add(domain);

// Create semantic domain configuration with pictures included
var config = BuildSemanticDomainConfig(includePictures: true);

// Create publication and decorator
var publication = CreateTestPublication("Test Publication");
testEntry.DoNotPublishInRC.Clear();
var decorator = new DictionaryPublicationDecorator(Cache, (ISilDataAccessManaged)Cache.DomainDataByFlid,
Cache.ServiceLocator.GetInstance<Virtuals>().LexDbEntries, publication);

// SUT
var result = ConfiguredLcmGenerator.GenerateContentForEntry(domain, config, decorator, DefaultSettings).ToString();
const string oneSenseWithPicture = picturesXpath + "/ div[@class='picture']/img[@class='photo' and @id]";
const string oneSenseWithPictureCaption = picturesXpath + "/ div[@class='picture']/div[@class='captionContent']/span[@class='caption']//span[text()='captionEn']";
//This assert is dependent on the specific entry data created in CreateInterestingLexEntry
AssertThatXmlIn.String(result).HasSpecifiedNumberOfMatchesForXpath(oneSenseWithPicture, 1);
AssertThatXmlIn.String(result).HasSpecifiedNumberOfMatchesForXpath(oneSenseWithPictureCaption, 1);
}

[Test]
public void GenerateXHTMLForSemanticDomain_PictureFileMissing()
{
// Create semantic domain
var domain = Cache.ServiceLocator.GetInstance<ICmSemanticDomainFactory>().Create();
Cache.LangProject.SemanticDomainListOA.PossibilitiesOS.Add(domain);

// Create entry and sense
var testEntry = CXGTests.CreateInterestingLexEntry(Cache);
var sense = testEntry.SensesOS[0];

// Add picture to sense, except the file is missing (bool exists = false)
sense.PicturesOS.Add(CXGTests.CreatePicture(Cache, false));

// Associate semantic domain with sense
sense.SemanticDomainsRC.Add(domain);

// Create semantic domain configuration with pictures included
var config = BuildSemanticDomainConfig(includePictures: true);

// Create publication and decorator
var publication = CreateTestPublication("Test Publication");
testEntry.DoNotPublishInRC.Clear();
var decorator = new DictionaryPublicationDecorator(Cache, (ISilDataAccessManaged)Cache.DomainDataByFlid,
Cache.ServiceLocator.GetInstance<Virtuals>().LexDbEntries, publication);

// SUT
var result = ConfiguredLcmGenerator.GenerateContentForEntry(domain, config, decorator, DefaultSettings).ToString();
const string picturePathNoMatches = picturesXpath + "/div[@class='picture']/div[@class='captionContent']/span[@class='captionorheadword']//span[text()='captionEn']";

//This assert is dependent on the specific entry data created
AssertThatXmlIn.String(result).HasSpecifiedNumberOfMatchesForXpath(picturesXpath, 0);
}

[Test]
public void GenerateXHTMLForSemanticDomain_CaptionOrHeadwordGetsCaption()
{
// Create semantic domain
var domain = Cache.ServiceLocator.GetInstance<ICmSemanticDomainFactory>().Create();
Cache.LangProject.SemanticDomainListOA.PossibilitiesOS.Add(domain);

// Create entry and sense
var testEntry = CXGTests.CreateInterestingLexEntry(Cache);
var sense = testEntry.SensesOS[0];

// Add picture to sense
sense.PicturesOS.Add(CXGTests.CreatePicture(Cache, true, "captionEn", "en"));
sense.PicturesOS[0].Caption.set_String(m_wsEn, TsStringUtils.MakeString("captionEn", m_wsEn));

// Associate semantic domain with sense
sense.SemanticDomainsRC.Add(domain);

// Create semantic domain configuration with pictures included
var config = BuildSemanticDomainConfig(includePictures: true);

// Create publication and decorator
var publication = CreateTestPublication("Test Publication");
testEntry.DoNotPublishInRC.Clear();
var decorator = new DictionaryPublicationDecorator(Cache, (ISilDataAccessManaged)Cache.DomainDataByFlid,
Cache.ServiceLocator.GetInstance<Virtuals>().LexDbEntries, publication);

// SUT
var result = ConfiguredLcmGenerator.GenerateContentForEntry(domain, config, decorator, DefaultSettings).ToString();
const string captionOrHeadwordContainsCaption = picturesXpath+ "/div[@class='picture']/div[@class='captionContent']/span[@class='captionorheadword']//span[text()='captionEn']";

//This assert is dependent on the specific entry data created
AssertThatXmlIn.String(result).HasSpecifiedNumberOfMatchesForXpath(captionOrHeadwordContainsCaption, 1);
}
#endregion Tests
}
}
Loading