Skip to content

Commit

Permalink
Selftests removed from library and placed into test-internals.
Browse files Browse the repository at this point in the history
Selftests extracted (removed) from zxcvbn.c and test.c and placed
into test-internals.c
Makefile updated.
  • Loading branch information
Perlbotics committed Nov 21, 2017
1 parent 3417c5e commit f7037ff
Show file tree
Hide file tree
Showing 4 changed files with 154 additions and 146 deletions.
12 changes: 9 additions & 3 deletions makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ SONAME = libzxcvbn.so.0

WORDS = words-eng_wiki.txt words-female.txt words-male.txt words-passwd.txt words-surname.txt words-tv_film.txt

all: test-file test-inline test-c++inline test-c++file test-shlib test-statlib
all: test-file test-inline test-c++inline test-c++file test-shlib test-statlib test-internals

test-shlib: test.c $(TARGET_LIB)
if [ ! -e libzxcvbn.so ]; then ln -s $(TARGET_LIB) libzxcvbn.so; fi
Expand Down Expand Up @@ -44,6 +44,10 @@ test-inline: test.c zxcvbn-inline.o
$(CC) $(CPPFLAGS) $(CFLAGS) \
-o test-inline test.c zxcvbn-inline.o $(LDFLAGS) -lm

test-internals: test-internals.c zxcvbn.c dict-crc.h zxcvbn.h
$(CC) $(CPPFLAGS) $(CFLAGS) \
-o test-internals test-internals.c $(LDFLAGS) -lm

zxcvbn-inline-pic.o: zxcvbn.c dict-src.h zxcvbn.h
$(CC) $(CPPFLAGS) $(CFLAGS) -fPIC -c -o $@ $<

Expand Down Expand Up @@ -80,7 +84,9 @@ zxcvbn-c++file.o: zxcvbn.c dict-crc.h zxcvbn.h
$(CXX) $(CPPFLAGS) $(CXXFLAGS) \
-DUSE_DICT_FILE -c -o zxcvbn-c++file.o zxcvbn.cpp

test: test-file test-inline test-c++inline test-c++file test-shlib test-statlib testcases.txt
test: test-internals test-file test-inline test-c++inline test-c++file test-shlib test-statlib testcases.txt
@echo Testing internals...
./test-internals
@echo Testing C build, dictionary from file
./test-file -t testcases.txt
@echo Testing C build, dictionary in executable
Expand All @@ -97,7 +103,7 @@ test: test-file test-inline test-c++inline test-c++file test-shlib test-statlib

clean:
rm -f test-file zxcvbn-file.o test-c++file zxcvbn-c++file.o
rm -f test-inline zxcvbn-inline.o zxcvbn-inline-pic.o test-c++inline zxcvbn-c++inline.o
rm -f test-inline test-internals zxcvbn-inline.o zxcvbn-inline-pic.o test-c++inline zxcvbn-c++inline.o
rm -f dict-*.h zxcvbn.dict zxcvbn.cpp test.cpp
rm -f dictgen
rm -f ${TARGET_LIB} ${SONAME} libzxcvbn.so test-shlib libzxcvbn.a test-statlib
145 changes: 145 additions & 0 deletions test-internals.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@

/* Internal tests that cannot be run against the library without unnecessary export of symbols.
Copyright (c) 2017, Perlbotics / see LICENSE.txt
*/


#include "zxcvbn.h"
/* need access to internals for testing; not linked against library, just inlined */
#include "zxcvbn.c"


/**********************************************************************************
* Internal checks: Validate if the first element of each group is sorted in
* ascending order. CharBinSearch(...) fails otherwise.
* Returns 0 on success.
* Returns element index [1..] of first error entry that is less than previous one.
*/
static int check_order(const uint8_t *Ents, unsigned int NumEnts, unsigned int SizeEnts) {
const uint8_t *last;
unsigned int i;

if (!Ents) return 0;
last = 0;

for (i = 0; i < NumEnts; ++i, Ents += SizeEnts) {
if (last && *last > *Ents) {
unsigned int j;

printf("Entry#%d [%d]: '%c' > '%c' (0x%02X > 0x%02X)\n A: ", i, i * SizeEnts, *last, *Ents, *last, *Ents);
for (j = 0; j < SizeEnts; ++j) {
printf("'%c' ", last[j] ? last[j] : ' ');
}
printf("\n >\n B: ");
for (j = 0; j < SizeEnts; ++j) {
printf("'%c' ", Ents[j] ? Ents[j] : ' ');
}
printf("\n");

return i;
}
last = Ents;
}

return 0; /* cannot be a misordered position; first possible one: 1 */
}

/**********************************************************************************
* Internal checks: Checks keyboard data integrity.
* Returns 0 on succes.
* Otherwise, number of errors are reported.
*/
static unsigned int selftest_keyboards() {
unsigned int errors;
const Keyboard_t *k;
unsigned int Indx;
const uint8_t *keys;
int i,j,errpos, blanks;

errors = 0;
for(k = Keyboards, Indx = 0; Indx < (sizeof Keyboards / sizeof Keyboards[0]); ++Indx, ++k) {
/* if one of these assrtion fails, we cannot use binary search algorithm */
if (k->Shifts && strlen((const char*)k->Shifts) % 2 == 1) {
printf("ERROR: Keyboard[%d]: Shifts-string has odd number of entries.\n", Indx);
++errors;
}

if ( (errpos = check_order(k->Shifts, k->NumShift, 2)) ) {
printf("ERROR: Keyboard[%d]: Error above in sort order of Shifts-string near item #%d.\n", Indx, errpos);
++errors;
}

if ( (errpos = check_order(k->Keys, k->NumKeys, k->NumNear)) ) {
printf("ERROR: Keyboard[%d]: Error above in sort order of keyboard-entries! Problem near item #%d.\n", Indx, errpos);
++errors;
continue;
}

/* For each key (c0), check all its neighbours (ci):
* Does the neighbour key (c1==ci) have an entry (cx) in the opposite direction [rev_idx]
* pointing back to the current key c0?
* c0: ...ci.. --> c1: ..cx... --> cx==c0?
*/
keys = k->Keys;
blanks = 0;
for(i = 0; i < k->NumKeys; ++i) {
uint8_t c0;
c0 = keys[i * k->NumNear];

for (j = 0; j < k->NumNear - 1; ++j) {
const uint8_t *c1;
uint8_t ci, cx;
int rev_idx;

/* rev_idx: reverse/opposite index to find opposite key location [0..6|8] --> [0..6|8] */
rev_idx = (j + (k->NumNear - 1)/2) % (k->NumNear - 1);
ci = keys[i * k->NumNear + j + 1];

if (ci) {
c1 = CharBinSearch(ci, keys, k->NumKeys, k->NumNear);
if (c1) {
if (ci == c0) {
printf("ERROR: Keyboard[%d]: recursion - key '%c' cannot be its own neighbour!\n", Indx, *c1);
++errors;
} else {
if ( (cx = c1[ 1 + rev_idx ]) ) {
if ( cx != c0 ) {
printf("ERROR: Keyboard[%d]: c0='%c':...(ci=%c)... -> c1='%c':...(cx=%c)... --!--> c0='%c':... \n",
Indx, c0, ci, *c1, cx, c0);
++errors;
}
} else { /* reverse pointer is NULL */
printf("ERROR: Keyboard[%d]: reverse entry missing in row c1='%c'[%d] pointing back to c0='%c'!\n", Indx, *c1, 1+rev_idx, c0);
++errors;
}
}
} else {
printf("ERROR: Keyboard[%d]: no entry (neighbour list) found for src-char c1==ci='%c'\n", Indx, ci);
++errors;
}
} else { /* blank neighbour key reference found */
++blanks;
}
}
}
if (blanks != k->NumBlank) {
printf("ERROR: Keyboard[%d]: number of blank keys announced (%d) does not match number of blank keys counted (%d)!\n",
Indx, k->NumBlank, blanks);
++errors;
}
}
return errors;
}




int main() {
unsigned int errors;

if( (errors = selftest_keyboards()) ){ /* currently only these */
printf("FAILED: [KEYBOARDS] - selftest returned %d error(s).\n", errors);
}

return errors ? 1 : 0;
}
9 changes: 0 additions & 9 deletions test.c
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@
#include "stdafx.h"
#endif

/* forward declaration / not part of official API */
unsigned int _selftest_errors();

const char *UsrDict[] =
{
"Onename.Twoname@example.com", "Onename", "Twoname", "example.com", "example",
Expand Down Expand Up @@ -210,16 +207,10 @@ int DoChecks(char *file)
int main(int argc, char **argv)
{
int i, Quiet, Checks, White;
unsigned int SelftestErrors;
Quiet = 0;
Checks = 0;
White = 0;

SelftestErrors = _selftest_errors();
printf("Selftest returned %d error(s).\n", SelftestErrors );
if (SelftestErrors)
return 1;

if (!ZxcvbnInit("zxcvbn.dict"))
{
printf("Failed to open dictionary file\n");
Expand Down
134 changes: 0 additions & 134 deletions zxcvbn.c
Original file line number Diff line number Diff line change
Expand Up @@ -1766,137 +1766,3 @@ void ZxcvbnFreeInfo(ZxcMatch_t *Info)
Info = p;
}
}

/**********************************************************************************
* Internal checks: Validate if the first element of each group is sorted in
* ascending order. CharBinSearch(...) fails otherwise.
* Returns 0 on success.
* Returns element index [1..] of first error entry that is less than previous one.
*/
static int _check_order(const uint8_t *Ents, unsigned int NumEnts, unsigned int SizeEnts) {
const uint8_t *last;
unsigned int i;

if (!Ents) return 0;
last = 0;

for (i = 0; i < NumEnts; ++i, Ents += SizeEnts) {
if (last && *last > *Ents) {
unsigned int j;

printf("Entry#%d [%d]: '%c' > '%c' (0x%02X > 0x%02X)\n A: ", i, i * SizeEnts, *last, *Ents, *last, *Ents);
for (j = 0; j < SizeEnts; ++j) {
printf("'%c' ", last[j] ? last[j] : ' ');
}
printf("\n >\n B: ");
for (j = 0; j < SizeEnts; ++j) {
printf("'%c' ", Ents[j] ? Ents[j] : ' ');
}
printf("\n");

return i;
}
last = Ents;
}

return 0; /* cannot be a misordered position; first possible one: 1 */
}

/**********************************************************************************
* Internal checks: Checks keyboard data integrity.
* Returns 0 on succes.
* Otherwise, number of errors are reported.
*/
static unsigned int _selftest_keyboards() {
unsigned int errors;
const Keyboard_t *k;
unsigned int Indx;
const uint8_t *keys;
int i,j,errpos, blanks;

errors = 0;
for(k = Keyboards, Indx = 0; Indx < (sizeof Keyboards / sizeof Keyboards[0]); ++Indx, ++k) {
/* if one of these assrtion fails, we cannot use binary search algorithm */
if (k->Shifts && strlen((const char*)k->Shifts) % 2 == 1) {
printf("ERROR: Keyboard[%d]: Shifts-string has odd number of entries.\n", Indx);
++errors;
}

if ( (errpos = _check_order(k->Shifts, k->NumShift, 2)) ) {
printf("ERROR: Keyboard[%d]: Error above in sort order of Shifts-string near item #%d.\n", Indx, errpos);
++errors;
}

if ( (errpos = _check_order(k->Keys, k->NumKeys, k->NumNear)) ) {
printf("ERROR: Keyboard[%d]: Error above in sort order of keyboard-entries! Problem near item #%d.\n", Indx, errpos);
++errors;
continue;
}

/* For each key (c0), check all its neighbours (ci):
* Does the neighbour key (c1==ci) have an entry (cx) in the opposite direction [rev_idx]
* pointing back to the current key c0?
* c0: ...ci.. --> c1: ..cx... --> cx==c0?
*/
keys = k->Keys;
blanks = 0;
for(i = 0; i < k->NumKeys; ++i) {
uint8_t c0;
c0 = keys[i * k->NumNear];

for (j = 0; j < k->NumNear - 1; ++j) {
const uint8_t *c1;
uint8_t ci, cx;
int rev_idx;

/* rev_idx: reverse/opposite index to find opposite key location [0..6|8] --> [0..6|8] */
rev_idx = (j + (k->NumNear - 1)/2) % (k->NumNear - 1);
ci = keys[i * k->NumNear + j + 1];

if (ci) {
c1 = CharBinSearch(ci, keys, k->NumKeys, k->NumNear);
if (c1) {
if (ci == c0) {
printf("ERROR: Keyboard[%d]: recursion - key '%c' cannot be its own neighbour!\n", Indx, *c1);
++errors;
} else {
if ( (cx = c1[ 1 + rev_idx ]) ) {
if ( cx != c0 ) {
printf("ERROR: Keyboard[%d]: c0='%c':...(ci=%c)... -> c1='%c':...(cx=%c)... --!--> c0='%c':... \n",
Indx, c0, ci, *c1, cx, c0);
++errors;
}
} else { /* reverse pointer is NULL */
printf("ERROR: Keyboard[%d]: reverse entry missing in row c1='%c'[%d] pointing back to c0='%c'!\n", Indx, *c1, 1+rev_idx, c0);
++errors;
}
}
} else {
printf("ERROR: Keyboard[%d]: no entry (neighbour list) found for src-char c1==ci='%c'\n", Indx, ci);
++errors;
}
} else { /* blank neighbour key reference found */
++blanks;
}
}
}
if (blanks != k->NumBlank) {
printf("ERROR: Keyboard[%d]: number of blank keys announced (%d) does not match number of blank keys counted (%d)!\n",
Indx, k->NumBlank, blanks);
++errors;
}
}
return errors;
}

/**********************************************************************************
* Performs all internal checks.
* Should be used by test programs. Might be used by applications.
* Returns 0 on success (no output).
* Reports number of errors otherwise. Error indication printed to STDOUT.
*/
unsigned int _selftest_errors() {
unsigned int errors;
errors = _selftest_keyboards(); /* currently only these */
return errors;
}

0 comments on commit f7037ff

Please sign in to comment.