Skip to content

iox-1855 Return in WaitSet::wait if data was send before WaitSet::attachState #1856

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
merged 4 commits into from
Jan 25, 2023
Merged

iox-1855 Return in WaitSet::wait if data was send before WaitSet::attachState #1856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af192db
iox-#1855 Check state condition and notify if 'true' when attaching s…
mossmaurice-apexai Jan 24, 2023
fc89f72
iox-#1855 Add tests for state condition check on 'WaitSet::attachState'
mossmaurice-apexai Jan 24, 2023
bea7318
iox-#1855 Add release note entry for 'WaitSet::wait' return bugfix
mossmaurice-apexai Jan 24, 2023
ab38967
iox-#1855 Add test cases for scenario where we 'WaitSet::wait' for a …
mossmaurice-apexai Jan 25, 2023
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
1 change: 1 addition & 0 deletions doc/website/release-notes/iceoryx-unreleased.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
- Avoid UB when accessing `iox::expected` [\#1750](https://github.com/eclipse-iceoryx/iceoryx/issues/1750)
- Fix double move in `vector::emplace` [\#1823](https://github.com/eclipse-iceoryx/iceoryx/issues/1823)
- Default roudi_config.toml path is not used [\#1826](https://github.com/eclipse-iceoryx/iceoryx/issues/1826)
- `WaitSet::wait` returns if data was send before `WaitSet::attachState(.., State::HAS_{DATA, REQUEST, RESPONSE})` [\#1855](https://github.com/eclipse-iceoryx/iceoryx/issues/1855)

**Refactoring:**

Expand Down
12 changes: 12 additions & 0 deletions iceoryx_posh/include/iceoryx_posh/internal/popo/wait_set.inl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,12 @@ WaitSet<Capacity>::attachState(T& stateOrigin,
stateOrigin,
TriggerHandle(*m_conditionVariableDataPtr, {*this, &WaitSet::removeTrigger}, uniqueId),
stateType);

auto& trigger = m_triggerArray[uniqueId];
if (trigger->isStateConditionSatisfied())
{
ConditionNotifier(*m_conditionVariableDataPtr, uniqueId).notify();
}
});
}

Expand All @@ -259,6 +265,12 @@ inline expected<WaitSetError> WaitSet<Capacity>::attachState(
.and_then([&](auto& uniqueId) {
NotificationAttorney::enableState(
stateOrigin, TriggerHandle(*m_conditionVariableDataPtr, {*this, &WaitSet::removeTrigger}, uniqueId));

auto& trigger = m_triggerArray[uniqueId];
if (trigger->isStateConditionSatisfied())
{
ConditionNotifier(*m_conditionVariableDataPtr, uniqueId).notify();
}
});
}

Expand Down
63 changes: 63 additions & 0 deletions iceoryx_posh/test/moduletests/test_popo_waitset.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1761,4 +1761,67 @@ TEST_F(WaitSet_test, TimedWaitUnblocksAfterMarkForDestructionCall)
t.join();
}

TEST_F(WaitSet_test, WaitSetReturnsIfStateTriggeredBeforeAttachingWithEventType)
{
::testing::Test::RecordProperty("TEST_ID", "407dc160-a50c-45b3-84bc-92a5f186fc14");
m_simpleEvents[0U].m_autoResetTrigger = false;
m_simpleEvents[0U].trigger();

ASSERT_FALSE(m_sut->attachState(m_simpleEvents[0U], SimpleState1::STATE1).has_error());

auto triggerVector = m_sut->timedWait(iox::units::Duration::fromSeconds(1337));
ASSERT_THAT(triggerVector.size(), Eq(1U));
EXPECT_TRUE(triggerVector[0U]->doesOriginateFrom(&m_simpleEvents[0U]));
}

TEST_F(WaitSet_test, WaitSetReturnsIfStateTriggeredBeforeAttachingWithEventId)
{
::testing::Test::RecordProperty("TEST_ID", "5753de85-7b34-4024-bd50-938c8885d269");
m_simpleEvents[0U].m_autoResetTrigger = false;
m_simpleEvents[0U].trigger();

ASSERT_FALSE(m_sut->attachState(m_simpleEvents[0U], 0U).has_error());

auto triggerVector = m_sut->timedWait(iox::units::Duration::fromSeconds(1337));
ASSERT_THAT(triggerVector.size(), Eq(1U));
EXPECT_TRUE(triggerVector[0U]->doesOriginateFrom(&m_simpleEvents[0U]));
}

TEST_F(WaitSet_test, WaitSetReturnsAgainIfStateTriggeredBeforeAttachingWithEventType)
{
::testing::Test::RecordProperty("TEST_ID", "c86d2592-e8e5-4acc-b468-0a82be82fe7c");
m_simpleEvents[0U].m_autoResetTrigger = false;
m_simpleEvents[0U].trigger();

ASSERT_FALSE(m_sut->attachState(m_simpleEvents[0U], SimpleState1::STATE1).has_error());

auto triggerVector1 = m_sut->timedWait(iox::units::Duration::fromSeconds(1337));
ASSERT_THAT(triggerVector1.size(), Eq(1U));
EXPECT_TRUE(triggerVector1[0U]->doesOriginateFrom(&m_simpleEvents[0U]));

// Waiting for another time should lead to the same result
auto triggerVector2 = m_sut->timedWait(iox::units::Duration::fromSeconds(1337));
ASSERT_THAT(triggerVector2.size(), Eq(1U));
EXPECT_TRUE(triggerVector2[0U]->doesOriginateFrom(&m_simpleEvents[0U]));
}

TEST_F(WaitSet_test, WaitSetReturnsAgainIfStateTriggeredBeforeAttachingWithEventId)
{
::testing::Test::RecordProperty("TEST_ID", "b07c9e09-f497-4bfa-9403-633d15363f5e");
m_simpleEvents[0U].m_autoResetTrigger = false;
m_simpleEvents[0U].trigger();

ASSERT_FALSE(m_sut->attachState(m_simpleEvents[0U], 0U).has_error());

auto triggerVector1 = m_sut->timedWait(iox::units::Duration::fromSeconds(1337));
ASSERT_THAT(triggerVector1.size(), Eq(1U));
EXPECT_TRUE(triggerVector1[0U]->doesOriginateFrom(&m_simpleEvents[0U]));

// Waiting for another time should lead to the same result
auto triggerVector2 = m_sut->timedWait(iox::units::Duration::fromSeconds(1337));
ASSERT_THAT(triggerVector2.size(), Eq(1U));
EXPECT_TRUE(triggerVector2[0U]->doesOriginateFrom(&m_simpleEvents[0U]));
}


} // namespace