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

Allow and ignore '-' characters in manual pairing codes. #22238

Merged
merged 2 commits into from
Sep 8, 2022
Merged

Allow and ignore '-' characters in manual pairing codes. #22238

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
e1991ed
Allow and ignore '-' characters in manual pairing codes.
bzbarsky-apple Aug 29, 2022
57b77f4
Add test per review comment.
bzbarsky-apple Aug 30, 2022
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
11 changes: 10 additions & 1 deletion src/setup_payload/ManualSetupPayloadParser.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

#include "SetupPayload.h"

#include <algorithm>
#include <lib/core/CHIPError.h>
#include <string>
#include <utility>
Expand All @@ -41,7 +42,15 @@ class ManualSetupPayloadParser
std::string mDecimalStringRepresentation;

public:
ManualSetupPayloadParser(std::string decimalRepresentation) : mDecimalStringRepresentation(std::move(decimalRepresentation)) {}
ManualSetupPayloadParser(std::string decimalRepresentation) : mDecimalStringRepresentation(std::move(decimalRepresentation))
{
// '-' might be being used in the decimal code as a digit group
// separator, to aid in readability. It's not actually part of the
// decomal code, so strip it out.
mDecimalStringRepresentation.erase(
std::remove(mDecimalStringRepresentation.begin(), mDecimalStringRepresentation.end(), '-'),
mDecimalStringRepresentation.end());
}
CHIP_ERROR populatePayload(SetupPayload & outPayload);

static CHIP_ERROR CheckDecimalStringValidity(std::string decimalString, std::string & decimalStringWithoutCheckDigit);
Expand Down
29 changes: 29 additions & 0 deletions src/setup_payload/tests/TestManualCode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@
#include <lib/support/UnitTestRegistration.h>
#include <lib/support/verhoeff/Verhoeff.h>

#include <algorithm>
#include <math.h>
#include <string>

using namespace chip;

Expand Down Expand Up @@ -202,6 +204,14 @@ void TestGenerateAndParser_ManualSetupCodeWithLongDiscriminator(nlTestSuite * in
}
}

char ComputeCheckChar(const std::string & str)
{
// Strip out dashes, if any, from the string before computing the checksum.
std::string copy(str);
copy.erase(std::remove(copy.begin(), copy.end(), '-'), copy.end());
return Verhoeff10::ComputeCheckChar(copy.c_str());
}

void TestPayloadParser_FullPayload(nlTestSuite * inSuite, void * inContext)
{
SetupPayload payload;
Expand All @@ -216,6 +226,15 @@ void TestPayloadParser_FullPayload(nlTestSuite * inSuite, void * inContext)
discriminator.SetShortValue(0xa);
assertPayloadValues(inSuite, err, CHIP_NO_ERROR, payload, 123456780, discriminator, 45367, 14526);

// The same thing, but with dashes separating digit groups.
decimalString = "6361-0875-3545-3671-4526";
decimalString += ComputeCheckChar(decimalString.c_str());
err = ManualSetupPayloadParser(decimalString).populatePayload(payload);
NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR);

discriminator.SetShortValue(0xa);
assertPayloadValues(inSuite, err, CHIP_NO_ERROR, payload, 123456780, discriminator, 45367, 14526);

decimalString = "52927623630456200032";
decimalString += Verhoeff10::ComputeCheckChar(decimalString.c_str());
err = ManualSetupPayloadParser(decimalString).populatePayload(payload);
Expand Down Expand Up @@ -288,6 +307,16 @@ void TestPayloadParser_PartialPayload(nlTestSuite * inSuite, void * inContext)
discriminator.SetShortValue(0xa);
assertPayloadValues(inSuite, err, CHIP_NO_ERROR, payload, 123456780, discriminator, 0, 0);

// The same thing, but with dashes separating digit groups.
decimalString = "236-108753-5";
decimalString += ComputeCheckChar(decimalString.c_str());
NL_TEST_ASSERT(inSuite, decimalString.length() == 13);
err = ManualSetupPayloadParser(decimalString).populatePayload(payload);
NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR);

discriminator.SetShortValue(0xa);
assertPayloadValues(inSuite, err, CHIP_NO_ERROR, payload, 123456780, discriminator, 0, 0);

decimalString = "0000010000";
decimalString += Verhoeff10::ComputeCheckChar(decimalString.c_str());
NL_TEST_ASSERT(inSuite, decimalString.length() == 11);
Expand Down