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.

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

HPCC-31364: Improve work unit ID detection for WUQuery filtering #19396

Merged
merged 1 commit into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 21 additions & 6 deletions common/workunit/workunit.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14041,17 +14041,32 @@ extern WORKUNIT_API void gatherLibraryNames(StringArray &names, StringArray &unr
}
}

// Evaluates if wuid matches the pattern:
// firstChar # # # # # # # # "-" # # # # # # [ "-" #+ ]
// All other deviations from the pattern, including an incomplete match or the use of wildcard
// characters, will return false.
bool looksLikeAWuid(const char * wuid, const char firstChar)
{
if (!wuid)
return false;
if (wuid[0] != firstChar)
// pattern match required content
if ((toupper(wuid[0]) != toupper(firstChar)) ||
!isdigit(wuid[1]) || !isdigit(wuid[2]) || !isdigit(wuid[3]) || !isdigit(wuid[4]) ||
!isdigit(wuid[5]) || !isdigit(wuid[6]) || !isdigit(wuid[7]) || !isdigit(wuid[8]) ||
('-' != wuid[9]) ||
!isdigit(wuid[10]) || !isdigit(wuid[11]) || !isdigit(wuid[12]) ||
!isdigit(wuid[13]) || !isdigit(wuid[14]) || !isdigit(wuid[15]))
return false;
if (!isdigit(wuid[1]) || !isdigit(wuid[2]) || !isdigit(wuid[3]) || !isdigit(wuid[4]))
return false;
if (!isdigit(wuid[5]) || !isdigit(wuid[6]) || !isdigit(wuid[7]) || !isdigit(wuid[8]))
return false;
return (wuid[9]=='-');
// pattern match optional content
size_t idx = 16;
if ('-' == wuid[16] && isdigit(wuid[17]))
{
idx += 2;
while (isdigit(wuid[idx]))
idx++;
}
// expect the NULL terminator
return ('\0' == wuid[idx]);
}

IPropertyTree * resolveDefinitionInArchive(IPropertyTree * archive, const char * path)
Expand Down
31 changes: 24 additions & 7 deletions ecl/eclplus/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,37 @@
#define ERROR_NO_SERVER 3
#define ERROR_CODE_USAGE 4

//copied from workunit.dll to avoid a dependency. Should possibly go in jlib.
// Evaluates if wuid matches the pattern:
// 'W' # # # # # # # # "-" # # # # # # [ "-" #+ ]
// All other deviations from the pattern, including an incomplete match or the use of wildcard
// characters, will return false.
//
// Copied from workunit.dll to avoid a dependency. Should possibly go in jlib.
static bool localLooksLikeAWuid(const char * wuid)
{
if (!wuid)
return false;
if (wuid[0] != 'W')
// pattern match required content
if ((toupper(wuid[0]) != 'W') ||
!isdigit(wuid[1]) || !isdigit(wuid[2]) || !isdigit(wuid[3]) || !isdigit(wuid[4]) ||
!isdigit(wuid[5]) || !isdigit(wuid[6]) || !isdigit(wuid[7]) || !isdigit(wuid[8]) ||
('-' != wuid[9]) ||
!isdigit(wuid[10]) || !isdigit(wuid[11]) || !isdigit(wuid[12]) ||
!isdigit(wuid[13]) || !isdigit(wuid[14]) || !isdigit(wuid[15]))
return false;
if (!isdigit(wuid[1]) || !isdigit(wuid[2]) || !isdigit(wuid[3]) || !isdigit(wuid[4]))
return false;
if (!isdigit(wuid[5]) || !isdigit(wuid[6]) || !isdigit(wuid[7]) || !isdigit(wuid[8]))
return false;
return (wuid[9]=='-');
// pattern match optional content
size_t idx = 16;
if ('-' == wuid[16] && isdigit(wuid[17]))
{
idx += 2;
while (isdigit(wuid[idx]))
idx++;
}
// expect the NULL terminator
return ('\0' == wuid[idx]);
}


void usage()
{
printf("eclplus action=[list|view|dump|delete|abort|query|graph]\n");
Expand Down
2 changes: 2 additions & 0 deletions testing/unittests/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ set ( SRCS
fxpptests.cpp
espapicmdtests.cpp
filetests.cpp
wutests.cpp
${HPCC_SOURCE_DIR}/esp/bindings/SOAP/xpp/fxpp/FragmentedXmlPullParser.cpp
${HPCC_SOURCE_DIR}/esp/bindings/SOAP/xpp/fxpp/FragmentedXmlAssistant.cpp
${CMAKE_BINARY_DIR}/generated/ws_loggingservice_esp.cpp
Expand Down Expand Up @@ -86,6 +87,7 @@ include_directories (
${HPCC_SOURCE_DIR}/rtl/eclrtl
${HPCC_SOURCE_DIR}/rtl/include
${HPCC_SOURCE_DIR}/common/dllserver
${HPCC_SOURCE_DIR}/common/workunit
${HPCC_SOURCE_DIR}/ecl/hql
${HPCC_SOURCE_DIR}/esp/bindings
${HPCC_SOURCE_DIR}/esp/bindings/SOAP/xpp
Expand Down
82 changes: 82 additions & 0 deletions testing/unittests/wutests.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
/*##############################################################################

Copyright (C) 2025 HPCC Systems®.

Licensed under the Apache License, Version 2.0 (the "License", 'W'));
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
############################################################################## */

#ifdef _USE_CPPUNIT
#include "unittests.hpp"
#include "workunit.hpp"

class wuTests : public CppUnit::TestFixture
{
CPPUNIT_TEST_SUITE( wuTests );
CPPUNIT_TEST(testLooksLikeAWuid);
CPPUNIT_TEST_SUITE_END();

public:
wuTests(){}

void testLooksLikeAWuid()
{
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should pass", looksLikeAWuid("w12345678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should pass", looksLikeAWuid("W12345678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should pass", looksLikeAWuid("w12345678-123456-1", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should pass", looksLikeAWuid("w12345678-123456-12", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid(nullptr, 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("x12345678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("wx2345678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w1x345678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12x45678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w123x5678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w1234x678-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345x78-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w123456x8-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w1234567x-123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678x123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-x23456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-1x3456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-12x456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-123x56", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-1234x6", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-12345x", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-123456x", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-123456-x", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-123456-1x", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("w12345678-123456-1wx", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W1", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W123", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W1234", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W123456", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W1234567", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678-", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678-1", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678-12", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678-123", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678-1234", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678-12345", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("W12345678-123456-", 'W'));
CPPUNIT_ASSERT_MESSAGE("looksLikeAWuid should fail", !looksLikeAWuid("*", 'W'));
}
};

CPPUNIT_TEST_SUITE_REGISTRATION( wuTests );
CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( wuTests, "wu" );

#endif // _USE_CPPUNIT
Loading