Skip to content
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

BDEWCompatibilityValidator: extended validation of UserMessages #190

Merged
merged 2 commits into from
Nov 9, 2023
Merged

BDEWCompatibilityValidator: extended validation of UserMessages #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a75486
BDEWCompatibilityValidator: extended validation of UserMessages
koes-soptim Nov 9, 2023
1fbf8c3
Simplified InitiatorRole/ResponderRole checks
koes-soptim Nov 9, 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
53 changes: 52 additions & 1 deletion ...profile-bdew/src/main/java/com/helger/phase4/profile/bdew/BDEWCompatibilityValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@
import com.helger.phase4.crypto.ECryptoAlgorithmSign;
import com.helger.phase4.crypto.ECryptoAlgorithmSignDigest;
import com.helger.phase4.ebms3header.Ebms3AgreementRef;
import com.helger.phase4.ebms3header.Ebms3CollaborationInfo;
import com.helger.phase4.ebms3header.Ebms3From;
import com.helger.phase4.ebms3header.Ebms3PartyId;
import com.helger.phase4.ebms3header.Ebms3PartyInfo;
import com.helger.phase4.ebms3header.Ebms3Service;
import com.helger.phase4.ebms3header.Ebms3SignalMessage;
import com.helger.phase4.ebms3header.Ebms3To;
import com.helger.phase4.ebms3header.Ebms3UserMessage;
Expand Down Expand Up @@ -509,14 +511,36 @@ public void validateUserMessage (@Nonnull final Ebms3UserMessage aUserMsg, @Nonn
if (aFrom != null)
{
if (aFrom.getPartyIdCount () > 1)
{
aErrorList.add (_createError ("PartyInfo/From must contain no more than one PartyID"));
}

if (!CAS4.DEFAULT_INITIATOR_URL.equals (aFrom.getRole ()))
{
aErrorList.add (_createError ("PartyInfo/From/Role must be set to '" + CAS4.DEFAULT_INITIATOR_URL + "'"));
}
}
else
{
aErrorList.add (_createError ("PartyInfo/From is missing"));
}

final Ebms3To aTo = aUserMsg.getPartyInfo ().getTo ();
if (aTo != null)
{
if (aTo.getPartyIdCount () > 1)
{
aErrorList.add (_createError ("PartyInfo/To must contain no more than one PartyID"));
}

if (!CAS4.DEFAULT_RESPONDER_URL.equals (aTo.getRole ()))
{
aErrorList.add (_createError ("PartyInfo/To/Role must be set to '" + CAS4.DEFAULT_RESPONDER_URL + "'"));
}
}
else
{
aErrorList.add (_createError ("PartyInfo/To is missing"));
}
}

Expand All @@ -526,7 +550,8 @@ public void validateUserMessage (@Nonnull final Ebms3UserMessage aUserMsg, @Nonn
}
else
{
final Ebms3AgreementRef aAgreementRef = aUserMsg.getCollaborationInfo ().getAgreementRef ();
final Ebms3CollaborationInfo aCollaborationInfo = aUserMsg.getCollaborationInfo ();
final Ebms3AgreementRef aAgreementRef = aCollaborationInfo.getAgreementRef ();
if (aAgreementRef == null)
{
aErrorList.add (_createError ("CollaborationInfo/AgreementRef must be set!"));
Expand All @@ -543,6 +568,32 @@ public void validateUserMessage (@Nonnull final Ebms3UserMessage aUserMsg, @Nonn
if (aAgreementRef.getType () != null)
aErrorList.add (_createError ("CollaborationInfo/Type must not be set!"));
}

Ebms3Service aService = aCollaborationInfo.getService();
if (aService == null || StringHelper.hasNoText (aService.getValue ()))
{
aErrorList.add (_createError ("CollaborationInfo/Service is missing"));
}
else
{
if (!BDEWPMode.containsService (aService.getValue ()))
{
aErrorList.add (_createError ("CollaborationInfo/Service '" + aService.getValue() + "' is unsupported"));
}
}

String sAction = aCollaborationInfo.getAction();
if (StringHelper.hasNoText (sAction))
{
aErrorList.add (_createError ("CollaborationInfo/Action is missing"));
}
else
{
if (!BDEWPMode.containsAction (sAction))
{
aErrorList.add (_createError ("CollaborationInfo/Action '" + sAction + "' is unsupported"));
}
}
}
}

Expand Down
174 changes: 150 additions & 24 deletions ...ile-bdew/src/test/java/com/helger/phase4/profile/bdew/BDEWCompatibilityValidatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,9 @@
*/
package com.helger.phase4.profile.bdew;

import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertTrue;

import java.util.Locale;

import com.helger.phase4.CAS4;
import com.helger.phase4.model.pmode.PModeParty;
import com.helger.phase4.model.pmode.leg.PModeLegBusinessInformation;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Ignore;
import org.junit.Test;

import com.helger.commons.error.list.ErrorList;
import com.helger.commons.state.ETriState;
import com.helger.phase4.CAS4;
import com.helger.phase4.crypto.ECryptoAlgorithmCrypt;
import com.helger.phase4.crypto.ECryptoAlgorithmSign;
import com.helger.phase4.crypto.ECryptoAlgorithmSignDigest;
Expand All @@ -48,14 +36,26 @@
import com.helger.phase4.model.EMEPBinding;
import com.helger.phase4.model.pmode.IPModeIDProvider;
import com.helger.phase4.model.pmode.PMode;
import com.helger.phase4.model.pmode.PModeParty;
import com.helger.phase4.model.pmode.leg.EPModeSendReceiptReplyPattern;
import com.helger.phase4.model.pmode.leg.PModeLeg;
import com.helger.phase4.model.pmode.leg.PModeLegBusinessInformation;
import com.helger.phase4.model.pmode.leg.PModeLegErrorHandling;
import com.helger.phase4.model.pmode.leg.PModeLegProtocol;
import com.helger.phase4.model.pmode.leg.PModeLegSecurity;
import com.helger.phase4.soap.ESoapVersion;
import com.helger.phase4.wss.EWSSVersion;
import com.helger.photon.app.mock.PhotonAppWebTestRule;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Ignore;
import org.junit.Test;

import java.util.Locale;
import java.util.UUID;

import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertTrue;

/**
* All essentials need to be set and need to be not null since they are getting
Expand Down Expand Up @@ -580,6 +580,32 @@ public void testValidatePModeReceptionAwarenessDuplicateDetectionWrongValue ()
.contains ("ReceptionAwareness.DuplicateDetection must be defined and set to 'true'")));
}

@Test
public void testValidatePModeCorrect ()
{
final PModeLegBusinessInformation aBusinessInformation = BDEWPMode.generatePModeLegBusinessInformation ();
aBusinessInformation.setService (BDEWPMode.SERVICE_TEST);
aBusinessInformation.setAction (BDEWPMode.ACTION_TEST_SERVICE);

final PModeLegErrorHandling aErrorHandler = PModeLegErrorHandling.createUndefined ();
aErrorHandler.setReportAsResponse (true);
aErrorHandler.setReportProcessErrorNotifyConsumer (true);
aErrorHandler.setReportProcessErrorNotifyProducer (true);

final PModeLegSecurity aSecurityLeg = m_aPMode.getLeg1 ().getSecurity ();
aSecurityLeg.setSendReceipt (true);
aSecurityLeg.setPModeAuthorize (false);

m_aPMode.setLeg1 (new PModeLeg (PModeLegProtocol.createForDefaultSoapVersion ("https://test.example.org"),
aBusinessInformation,
aErrorHandler,
null,
aSecurityLeg));

VALIDATOR.validatePMode (m_aPMode, m_aErrorList);
assertTrue (m_aErrorList.isEmpty ());
}

@Test
public void testValidateUserMessageNoMessageInfo ()
{
Expand Down Expand Up @@ -618,6 +644,71 @@ public void testValidateUserMessageNoPartyInfo ()
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE).contains ("PartyInfo is missing")));
}

@Test
public void testValidateUserMessageNoPartyInfoFromAndTo ()
{
final Ebms3UserMessage aUserMessage = new Ebms3UserMessage ();
aUserMessage.setMessageInfo (new Ebms3MessageInfo ());
aUserMessage.setPartyInfo (new Ebms3PartyInfo());
VALIDATOR.validateUserMessage (aUserMessage, m_aErrorList);
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE).contains ("PartyInfo/From is missing")));
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE).contains ("PartyInfo/To is missing")));
}

@Test
public void testValidateUserMessageMoreThanOnePartyID ()
{
final Ebms3PartyId aFirstId = MessageHelperMethods.createEbms3PartyId ("type", "value");
final Ebms3PartyId aSecondId = MessageHelperMethods.createEbms3PartyId ("type2", "value2");

final Ebms3From aFromPart = new Ebms3From ();
aFromPart.addPartyId (aFirstId);
aFromPart.addPartyId (aSecondId);
final Ebms3To aToPart = new Ebms3To ();
aToPart.addPartyId (aFirstId);
aToPart.addPartyId (aSecondId);
final Ebms3PartyInfo aPartyInfo = new Ebms3PartyInfo ();
aPartyInfo.setFrom (aFromPart);
aPartyInfo.setTo (aToPart);

final Ebms3UserMessage aUserMessage = new Ebms3UserMessage ();
aUserMessage.setPartyInfo (aPartyInfo);

VALIDATOR.validateUserMessage (aUserMessage, m_aErrorList);
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE)
.contains ("must contain no more than one PartyID")));
}

@Test
public void testValidateUserMessagePartyInfoWrongRoles ()
{
final Ebms3PartyId aFirstId = MessageHelperMethods.createEbms3PartyId ("type", "value");
final Ebms3PartyId aSecondId = MessageHelperMethods.createEbms3PartyId ("type2", "value2");

final Ebms3From aFromPart = new Ebms3From ();
aFromPart.addPartyId (aFirstId);
aFromPart.addPartyId (aSecondId);
aFromPart.setRole ("http://test.example.org");

final Ebms3To aToPart = new Ebms3To ();
aToPart.addPartyId (aFirstId);
aToPart.addPartyId (aSecondId);
aToPart.setRole ("http://test.example.org");

final Ebms3PartyInfo aPartyInfo = new Ebms3PartyInfo ();
aPartyInfo.setFrom (aFromPart);
aPartyInfo.setTo (aToPart);

final Ebms3UserMessage aUserMessage = new Ebms3UserMessage ();
aUserMessage.setPartyInfo (aPartyInfo);

VALIDATOR.validateUserMessage (aUserMessage, m_aErrorList);
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE)
.contains ("PartyInfo/From/Role must be set to '" + CAS4.DEFAULT_INITIATOR_URL + "'")));
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE)
.contains ("PartyInfo/To/Role must be set to '" + CAS4.DEFAULT_RESPONDER_URL + "'")));
}

@Test
public void testValidateUserMessageNoCollaborationInfo ()
{
Expand Down Expand Up @@ -696,27 +787,62 @@ public void testValidateUserMessageWrongCollaborationInfoAgreementRefType ()
}

@Test
public void testValidateUserMessageMoreThanOnePartyID ()
public void testValidateUserMessageWrongCollaborationInfoService ()
{
final Ebms3PartyId aFirstId = MessageHelperMethods.createEbms3PartyId ("type", "value");
final Ebms3PartyId aSecondId = MessageHelperMethods.createEbms3PartyId ("type2", "value2");
final Ebms3UserMessage aUserMessage = new Ebms3UserMessage ();
aUserMessage.setMessageInfo (new Ebms3MessageInfo ());
final Ebms3CollaborationInfo aCollaborationInfo = new Ebms3CollaborationInfo ();
aCollaborationInfo.setService ("http://test.example.org");

aUserMessage.setCollaborationInfo (aCollaborationInfo);
VALIDATOR.validateUserMessage (aUserMessage, m_aErrorList);
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE)
.contains ("CollaborationInfo/Service 'http://test.example.org' is unsupported")));
}

@Test
public void testValidateUserMessageWrongCollaborationInfoAction ()
{
final Ebms3UserMessage aUserMessage = new Ebms3UserMessage ();
aUserMessage.setMessageInfo (new Ebms3MessageInfo ());
final Ebms3CollaborationInfo aCollaborationInfo = new Ebms3CollaborationInfo ();
aCollaborationInfo.setAction ("http://test.example.org");

aUserMessage.setCollaborationInfo (aCollaborationInfo);
VALIDATOR.validateUserMessage (aUserMessage, m_aErrorList);
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE)
.contains ("CollaborationInfo/Action 'http://test.example.org' is unsupported")));
}

@Test
public void testValidateUserMessageCorrect ()
{
final Ebms3UserMessage aUserMessage = new Ebms3UserMessage ();

Ebms3MessageInfo aMessageInfo = new Ebms3MessageInfo ();
aMessageInfo.setMessageId (UUID.randomUUID ().toString ());
aUserMessage.setMessageInfo (aMessageInfo);

final Ebms3From aFromPart = new Ebms3From ();
aFromPart.addPartyId (aFirstId);
aFromPart.addPartyId (aSecondId);
aFromPart.addPartyId (new Ebms3PartyId ("1"));
aFromPart.setRole (CAS4.DEFAULT_INITIATOR_URL);
final Ebms3To aToPart = new Ebms3To ();
aToPart.addPartyId (aFirstId);
aToPart.addPartyId (aSecondId);
aToPart.addPartyId (new Ebms3PartyId ("2"));
aToPart.setRole (CAS4.DEFAULT_RESPONDER_URL);
final Ebms3PartyInfo aPartyInfo = new Ebms3PartyInfo ();
aPartyInfo.setFrom (aFromPart);
aPartyInfo.setTo (aToPart);

final Ebms3UserMessage aUserMessage = new Ebms3UserMessage ();
aUserMessage.setPartyInfo (aPartyInfo);

final Ebms3CollaborationInfo aCollaborationInfo = new Ebms3CollaborationInfo ();
aCollaborationInfo.setAgreementRef (BDEWPMode.DEFAULT_AGREEMENT_ID);
aCollaborationInfo.setService (BDEWPMode.SERVICE_TEST);
aCollaborationInfo.setAction (BDEWPMode.ACTION_TEST_SERVICE);

aUserMessage.setCollaborationInfo (aCollaborationInfo);

VALIDATOR.validateUserMessage (aUserMessage, m_aErrorList);
assertTrue (m_aErrorList.containsAny (x -> x.getErrorText (LOCALE)
.contains ("must contain no more than one PartyID")));
assertTrue (m_aErrorList.isEmpty ());
}

@Test
Expand Down