tests/filesynced.t

   1 #!/usr/bin/env perl
   2
   3 #=======================================================================
   4 # filesynced.t
   5 # File ID: 8f5fa76e-a802-11e5-bb87-fefdb24f8e10
   6 #
   7 # Test suite for filesynced(1).
   8 #
   9 # Character set: UTF-8
  10 # ©opyleft 2015– Øyvind A. Holm <sunny@sunbase.org>
  11 # License: GNU General Public License version 2 or later, see end of
  12 # file for legal stuff.
  13 #=======================================================================
  14
  15 use strict;
  16 use warnings;
  17
  18 BEGIN {
  19     use Test::More qw{no_plan};
  20     # use_ok() goes here
  21 }
  22
  23 use Getopt::Long;
  24 use IPC::Open3;
  25
  26 local $| = 1;
  27
  28 our $CMDB = "filesynced";
  29 our $CMD = "../$CMDB";
  30 my $SQLITE = "sqlite3";
  31
  32 our %Opt = (
  33
  34     'all' => 0,
  35     'help' => 0,
  36     'quiet' => 0,
  37     'todo' => 0,
  38     'verbose' => 0,
  39     'version' => 0,
  40
  41 );
  42
  43 our $progname = $0;
  44 $progname =~ s/^.*\/(.*?)$/$1/;
  45 our $VERSION = '0.0.0';
  46
  47 my %descriptions = ();
  48
  49 Getopt::Long::Configure('bundling');
  50 GetOptions(
  51
  52     'all|a' => \$Opt{'all'},
  53     'help|h' => \$Opt{'help'},
  54     'quiet|q+' => \$Opt{'quiet'},
  55     'todo|t' => \$Opt{'todo'},
  56     'verbose|v+' => \$Opt{'verbose'},
  57     'version' => \$Opt{'version'},
  58
  59 ) || die("$progname: Option error. Use -h for help.\n");
  60
  61 $Opt{'verbose'} -= $Opt{'quiet'};
  62 $Opt{'help'} && usage(0);
  63 if ($Opt{'version'}) {
  64     print_version();
  65     exit(0);
  66 }
  67
  68 my $sql_error = 0;
  69
  70 exit(main());
  71
  72 sub main {
  73     # {{{
  74     my $Retval = 0;
  75
  76     diag(sprintf('========== Executing %s v%s ==========',
  77                  $progname, $VERSION));
  78
  79     if ($Opt{'todo'} && !$Opt{'all'}) {
  80         goto todo_section;
  81     }
  82
  83 =pod
  84
  85     testcmd("$CMD command", # {{{
  86         <<'END',
  87 [expected stdout]
  88 END
  89         '',
  90         0,
  91         'description',
  92     );
  93
  94     # }}}
  95
  96 =cut
  97
  98     diag('Testing -h (--help) option...');
  99     likecmd("$CMD -h", # {{{
 100         '/  Show this help/i',
 101         '/^$/',
 102         0,
 103         'Option -h prints help screen',
 104     );
 105
 106     # }}}
 107     diag('Testing -v (--verbose) option...');
 108     likecmd("$CMD -h -v", # {{{
 109         '/^\n\S+ \d+\.\d+\.\d+/s',
 110         '/^$/',
 111         0,
 112         'Option -v with -h returns version number and help screen',
 113     );
 114
 115     # }}}
 116     diag('Testing --version option...');
 117     likecmd("$CMD --version", # {{{
 118         '/^\S+ \d+\.\d+\.\d+/',
 119         '/^$/',
 120         0,
 121         'Option --version returns version number',
 122     );
 123
 124     # }}}
 125
 126     my $syncfile = "$ENV{'HOME'}/bin/synced.sql";
 127     if (!-r $syncfile) {
 128         diag("$syncfile not found, skipping tests");
 129         return 0;
 130     }
 131
 132     my $Tmptop = "tmp-filesynced-t-$$-" . substr(rand, 2, 8);
 133     my $GIT = "git";
 134
 135     ok(mkdir($Tmptop), "mkdir [Tmptop]");
 136     ok(chdir($Tmptop), "chdir [Tmptop]") || BAIL_OUT();
 137     likecmd("$GIT init repo-fs-t", # {{{
 138         '/.*/',
 139         '/.*/',
 140         0,
 141         "git init repo-fs-t",
 142     );
 143
 144     # }}}
 145     ok(-d "repo-fs-t/.git", "repo-fs-t/.git exists") || BAIL_OUT();
 146     ok(-d "../$Tmptop", "We're in [Tmptop]") || BAIL_OUT();
 147     ok(chdir("repo-fs-t"), "chdir repo-fs-t");
 148     $CMD = "../../../$CMDB";
 149     ok(-f $CMD, "Executable is in place") || BAIL_OUT();
 150     testcmd("$CMD -v", # No options, no database {{{
 151         '',
 152         "filesynced: synced.sqlite: Sync database not found\n",
 153         1,
 154         "No options, no database",
 155     );
 156
 157     # }}}
 158     testcmd("$CMD -l -v", # No database and -l {{{
 159         '',
 160         "filesynced: synced.sqlite: Sync database not found\n",
 161         1,
 162         "No database and -l",
 163     );
 164
 165     # }}}
 166     diag("--init");
 167     chomp(my $sql_create_synced = <<END); # {{{
 168 CREATE TABLE synced (
 169   file TEXT
 170     CONSTRAINT synced_file_length
 171       CHECK (length(file) > 0)
 172     UNIQUE
 173     NOT NULL
 174   ,
 175   orig TEXT
 176   ,
 177   rev TEXT
 178     CONSTRAINT synced_rev_length
 179       CHECK (length(rev) = 40 OR rev = '')
 180   ,
 181   date TEXT
 182     CONSTRAINT synced_date_length
 183       CHECK (date IS NULL OR length(date) = 19)
 184     CONSTRAINT synced_date_valid
 185       CHECK (date IS NULL OR datetime(date) IS NOT NULL)
 186 );
 187 END
 188     # }}}
 189     chomp(my $sql_create_todo = <<END); # {{{
 190 CREATE TABLE todo (
 191   file TEXT
 192     CONSTRAINT todo_file_length
 193       CHECK(length(file) > 0)
 194     UNIQUE
 195     NOT NULL
 196   ,
 197   pri INTEGER
 198     CONSTRAINT todo_pri_range
 199       CHECK(pri BETWEEN 1 AND 5)
 200   ,
 201   comment TEXT
 202 );
 203 END
 204     # }}}
 205     testcmd("$CMD --init", # {{{
 206         "",
 207         "",
 208         0,
 209         "--init without options",
 210     );
 211
 212     # }}}
 213     is(sql_dump("synced.sql"), <<END, "synced.sql is ok"); # {{{
 214 $sql_create_synced
 215 $sql_create_todo
 216 END
 217
 218     # }}}
 219     likecmd("$CMD --init", # {{{
 220         '/^$/',
 221         '/\/repo-fs-t\/synced.sql already exists\n$/s',
 222         1,
 223         "Refuse to --init when synced.sql exists",
 224     );
 225
 226     # }}}
 227     testcmd("sqlite3 synced.sqlite <synced.sql", '', '', 0, # {{{
 228         "Create synced.sqlite from synced.sql");
 229
 230     # }}}
 231     ok(unlink("synced.sql"), "Delete synced.sql");
 232     likecmd("$CMD --init", # {{{
 233         '/^$/',
 234         '/\/repo-fs-t\/synced.sqlite: File already exists\n' .
 235             'filesynced: No token received from filesynced --lock\n' .
 236             '$/s',
 237         1,
 238         "It also reacts negatively to the presence of synced.sqlite",
 239     );
 240
 241     # }}}
 242     ok(unlink("synced.sqlite"), "Delete synced.sqlite");
 243     diag("--lock");
 244     testcmd("$CMD --init", # {{{
 245         "",
 246         "",
 247         0,
 248         "Create synced.sql again with --init",
 249     );
 250
 251     # }}}
 252     testcmd("$CMD --lock >key.txt", "", "", 0, # {{{
 253         "Use --lock, store key in key.txt",
 254     );
 255
 256     # }}}
 257     my $realtoken = file_data("key.txt");
 258     likecmd("$CMD --lock --timeout 0", # {{{
 259         '/^$/',
 260         '/^' .
 261             'filesynced --lock: .+\/repo-fs-t\/synced.sql\.lock: ' .
 262               'Waiting for lockdir\.\.\.\n' .
 263             'filesynced: Lock not aquired after 0 seconds, aborting\n' .
 264             '$/s',
 265         1,
 266         "Try to lock again, wimp gives up after 0 seconds",
 267     );
 268
 269     # }}}
 270     like($realtoken, # {{{
 271         (
 272             '/^' .
 273             'token_' .
 274             '20\d\d' . '[01]\d' . '\d\d' .
 275             'T' .
 276             '[0-2]\d' . '[0-5]\d' . '[0-6]\d' .
 277             'Z' .
 278             '\.' .
 279             '\d+' .
 280             '\n' .
 281             '$/s'
 282         ),
 283         "key.txt looks ok",
 284     );
 285
 286     # }}}
 287     diag("--unlock");
 288     testcmd("$CMD --unlock", # {{{
 289         "",
 290         "filesynced --unlock: Token mismatch\n",
 291         1,
 292         "No argument to --unlock",
 293     );
 294
 295     # }}}
 296     testcmd("$CMD --unlock ''", # {{{
 297         "",
 298         "filesynced --unlock: Token mismatch\n",
 299         1,
 300         "--unlock receives empty string",
 301     );
 302
 303     # }}}
 304     testcmd("$CMD --unlock token_20141212T123456Z.1234." . ("2" x 40), # {{{
 305         "",
 306         "filesynced --unlock: Token mismatch\n",
 307         1,
 308         "--unlock token is wrong",
 309     );
 310
 311     # }}}
 312     testcmd("$CMD --unlock $realtoken", # {{{
 313         "",
 314         "",
 315         0,
 316         "--unlock token is valid",
 317     );
 318
 319     # }}}
 320     likecmd("$CMD --lock", # {{{
 321         '/^token_\S+\n$/',
 322         '/^$/',
 323         0,
 324         "--lock, throw away the token",
 325     );
 326
 327     # }}}
 328     testcmd("$CMD --unlock -f", # {{{
 329         "",
 330         "",
 331         0,
 332         "--unlock with -f (force)",
 333     );
 334
 335     # }}}
 336     likecmd("$CMD --lock", # {{{
 337         '/^token_\S+\n$/',
 338         '/^$/',
 339         0,
 340         "--lock again, throw away the token",
 341     );
 342
 343     # }}}
 344     testcmd("$CMD --force --unlock", # {{{
 345         "",
 346         "",
 347         0,
 348         "--unlock with --force",
 349     );
 350
 351     # }}}
 352     diag("--add");
 353     testcmd("$CMD --add nonexisting.txt", # {{{
 354         "",
 355         "filesynced: nonexisting.txt: File not found, no entries updated\n",
 356         1,
 357         "Try to --add non-existing file",
 358     );
 359
 360     # }}}
 361     ok(create_file("tmpfile.txt", "This is tmpfile.txt"),
 362         "Create tmpfile.txt");
 363     testcmd("$CMD --add tmpfile.txt nonexisting.txt", # {{{
 364         "",
 365         "filesynced: nonexisting.txt: File not found, no entries updated\n",
 366         1,
 367         "Try to --add existing and non-existing file",
 368     );
 369
 370     # }}}
 371     is(sql_dump("synced.sql"), # {{{
 372         <<END,
 373 $sql_create_synced
 374 $sql_create_todo
 375 END
 376         "tmpfile.txt is not added to synced.sql yet",
 377     );
 378
 379     # }}}
 380     testcmd("$CMD --add tmpfile.txt", # {{{
 381         "",
 382         "",
 383         0,
 384         "Add tmpfile.txt with --add",
 385     );
 386
 387     # }}}
 388     is(sql_dump("synced.sql"), # {{{
 389         <<END,
 390 $sql_create_synced
 391 $sql_create_todo
 392 synced|tmpfile.txt|NULL|NULL|NULL
 393 END
 394         "tmpfile.txt is added to synced.sql",
 395     );
 396
 397     # }}}
 398     likecmd("$CMD --add tmpfile.txt", # {{{
 399         '/^$/s',
 400         '/filesynced: Cannot add "tmpfile\.txt" to the database, ' .
 401             'no entries updated\n/s',
 402         1,
 403         "Fail to add it again",
 404     );
 405
 406     # }}}
 407     is(sql_dump("synced.sql"), # {{{
 408         <<END,
 409 $sql_create_synced
 410 $sql_create_todo
 411 synced|tmpfile.txt|NULL|NULL|NULL
 412 END
 413         "There's only one tmpfile.txt in synced.sql",
 414     );
 415
 416     # }}}
 417     ok(!-d "synced.sql.lock", "synced.sql.lock/ is gone");
 418     diag("--delete");
 419     testcmd("$CMD --delete nonexisting.txt", # {{{
 420         "",
 421         "",
 422         1,
 423         "--delete nonexisting.txt",
 424     );
 425
 426     # }}}
 427     testcmd("$CMD --delete tmpfile.txt", # {{{
 428         "",
 429         "filesynced: Deleted tmpfile.txt from synced\n",
 430         0,
 431         "--delete tmpfile.txt",
 432     );
 433
 434     # }}}
 435     is(sql_dump("synced.sql"), # {{{
 436         <<END,
 437 $sql_create_synced
 438 $sql_create_todo
 439 END
 440         "tmpfile.txt is gone from synced.sql",
 441     );
 442
 443     # }}}
 444     testcmd("$CMD --add -t bash tmpfile.txt", # {{{
 445         "",
 446         "",
 447         0,
 448         "Add tmpfile.txt again, now with -t bash",
 449     );
 450
 451     # }}}
 452     is(sql_dump("synced.sql"), # {{{
 453         <<END,
 454 $sql_create_synced
 455 $sql_create_todo
 456 synced|tmpfile.txt|Lib/std/bash|NULL|NULL
 457 END
 458         "tmpfile.txt is added to synced.sql with orig value",
 459     );
 460
 461     # }}}
 462     diag("--unsynced");
 463     create_file("file1", "This is file1.\n");
 464     testcmd("git add file1", # {{{
 465         '',
 466         '',
 467         0,
 468         "git add file1",
 469     );
 470
 471     # }}}
 472     likecmd("git commit -m 'Add file1'", # {{{
 473         '/^.+Add file1.+$/s',
 474         '/^$/',
 475         0,
 476         "git commit file1",
 477     );
 478
 479     # }}}
 480     testcmd("$CMD --unsynced", # {{{
 481         "",
 482         "",
 483         0,
 484         "file1 is not listed by --unsynced because " .
 485           "it's not in synced.sql",
 486     );
 487
 488     # }}}
 489     testcmd("$CMD --add -t Lib/std/bash file1", # {{{
 490         "",
 491         "",
 492         0,
 493         "--add file1",
 494     );
 495
 496     # }}}
 497     testcmd("$CMD --unsynced", # {{{
 498         "file1\n",
 499         "",
 500         0,
 501         "file1 is listed by --unsynced",
 502     );
 503
 504     # }}}
 505     testcmd("$CMD HEAD file1", # {{{
 506         "",
 507         "",
 508         0,
 509         "Mark file1 as updated",
 510     );
 511
 512     # }}}
 513     testcmd("$CMD --unsynced", # {{{
 514         "",
 515         "",
 516         0,
 517         "file1 should be gone from --unsynced now",
 518     );
 519
 520     # }}}
 521     # diag("--valid-sha");
 522     # FIXME: Create tests for --valid-sha. Have to set up some sync
 523     # rules first.
 524     testcmd("$CMD --delete file1", # {{{
 525         "",
 526         "filesynced: Deleted file1 from synced\n",
 527         0,
 528         "--delete file1",
 529     );
 530
 531     # }}}
 532     diag("--create-index");
 533     testcmd("$CMD --create-index", # {{{
 534         "",
 535         "",
 536         0,
 537         "Use with --create-index",
 538     );
 539
 540     # }}}
 541     is(sql_dump("synced.sql"), # {{{
 542         <<END,
 543 $sql_create_synced
 544 $sql_create_todo
 545 CREATE INDEX idx_synced_file ON synced (file);
 546 CREATE INDEX idx_synced_orig ON synced (orig);
 547 CREATE INDEX idx_synced_rev ON synced (rev);
 548 synced|tmpfile.txt|Lib/std/bash|NULL|NULL
 549 END
 550         "synced.sql contains indexes",
 551     );
 552
 553     # }}}
 554
 555     diag("Clean up");
 556     ok(chdir(".."), "chdir ..");
 557     testcmd("rm -rf repo-fs-t", '', '', 0, "Delete repo-fs-t/");
 558     ok(chdir(".."), "chdir ..");
 559     ok(rmdir($Tmptop), "rmdir [Tmptop]");
 560
 561     todo_section:
 562     ;
 563
 564     if ($Opt{'all'} || $Opt{'todo'}) {
 565         diag('Running TODO tests...'); # {{{
 566
 567         TODO: {
 568
 569             local $TODO = '';
 570             # Insert TODO tests here.
 571
 572         }
 573         # TODO tests }}}
 574     }
 575
 576     diag('Testing finished.');
 577     return $Retval;
 578     # }}}
 579 } # main()
 580
 581 sub sql {
 582     # {{{
 583     my ($db, $sql) = @_;
 584     my @retval = ();
 585
 586     msg(5, "sql(): db = '$db'");
 587     local(*CHLD_IN, *CHLD_OUT, *CHLD_ERR);
 588
 589     $sql_error = 0;
 590     my $pid = open3(*CHLD_IN, *CHLD_OUT, *CHLD_ERR, $SQLITE, $db) or (
 591         $sql_error = 1,
 592         msg(0, "sql(): open3() error: $!"),
 593         return("sql() error"),
 594     );
 595     msg(5, "sql(): sql = '$sql'");
 596     print(CHLD_IN "$sql\n") or msg(0, "sql(): print CHLD_IN error: $!");
 597     close(CHLD_IN);
 598     @retval = <CHLD_OUT>;
 599     msg(5, "sql(): retval = '" . join('|', @retval) . "'");
 600     my @child_stderr = <CHLD_ERR>;
 601     if (scalar(@child_stderr)) {
 602         msg(1, "$SQLITE error: " . join('', @child_stderr));
 603         $sql_error = 1;
 604     }
 605     return(join('', @retval));
 606     # }}}
 607 } # sql()
 608
 609 sub sqlite_dump {
 610     # Return contents of database file {{{
 611     my $File = shift;
 612
 613     return sql($File, <<END);
 614 .nullvalue NULL
 615 .schema
 616 SELECT 'synced', * FROM synced;
 617 END
 618     # }}}
 619 } # sqlite_dump()
 620
 621 sub sql_dump {
 622     # {{{
 623     my $File = shift;
 624     my $db = "$File.sqlite";
 625     my $Txt;
 626
 627     is(system("$SQLITE $db <$File"), 0, "Create $db from $File");
 628     ok(-f $db, "$db exists");
 629     $Txt = sqlite_dump("$db");
 630     ok(unlink($db), "Delete $db");
 631
 632     return $Txt;
 633     # }}}
 634 } # sql_dump()
 635
 636 sub testcmd {
 637     # {{{
 638     my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 639     defined($descriptions{$Desc}) &&
 640         BAIL_OUT("testcmd(): '$Desc' description is used twice");
 641     $descriptions{$Desc} = 1;
 642     my $stderr_cmd = '';
 643     my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 644     my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 645     my $TMP_STDERR = "$CMDB-stderr.tmp";
 646     my $retval = 1;
 647
 648     if (defined($Exp_stderr)) {
 649         $stderr_cmd = " 2>$TMP_STDERR";
 650     }
 651     $retval &= is(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 652     my $ret_val = $?;
 653     if (defined($Exp_stderr)) {
 654         $retval &= is(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 655         unlink($TMP_STDERR);
 656     } else {
 657         diag("Warning: stderr not defined for '$Txt'");
 658     }
 659     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 660
 661     return $retval;
 662     # }}}
 663 } # testcmd()
 664
 665 sub likecmd {
 666     # {{{
 667     my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 668     defined($descriptions{$Desc}) &&
 669         BAIL_OUT("likecmd(): '$Desc' description is used twice");
 670     $descriptions{$Desc} = 1;
 671     my $stderr_cmd = '';
 672     my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 673     my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 674     my $TMP_STDERR = "$CMDB-stderr.tmp";
 675     my $retval = 1;
 676
 677     if (defined($Exp_stderr)) {
 678         $stderr_cmd = " 2>$TMP_STDERR";
 679     }
 680     $retval &= like(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 681     my $ret_val = $?;
 682     if (defined($Exp_stderr)) {
 683         $retval &= like(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 684         unlink($TMP_STDERR);
 685     } else {
 686         diag("Warning: stderr not defined for '$Txt'");
 687     }
 688     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 689
 690     return $retval;
 691     # }}}
 692 } # likecmd()
 693
 694 sub file_data {
 695     # Return file content as a string {{{
 696     my $File = shift;
 697     my $Txt;
 698
 699     open(my $fp, '<', $File) or return undef;
 700     local $/ = undef;
 701     $Txt = <$fp>;
 702     close($fp);
 703     return $Txt;
 704     # }}}
 705 } # file_data()
 706
 707 sub create_file {
 708     # Create new file and fill it with data {{{
 709     my ($file, $text) = @_;
 710     my $retval = 0;
 711     if (open(my $fp, ">$file")) {
 712         print($fp $text);
 713         close($fp);
 714         $retval = is(
 715             file_data($file),
 716             $text,
 717             "$file was successfully created",
 718         );
 719     }
 720     return($retval); # 0 if error, 1 if ok
 721     # }}}
 722 } # create_file()
 723
 724 sub print_version {
 725     # Print program version {{{
 726     print("$progname $VERSION\n");
 727     return;
 728     # }}}
 729 } # print_version()
 730
 731 sub usage {
 732     # Send the help message to stdout {{{
 733     my $Retval = shift;
 734
 735     if ($Opt{'verbose'}) {
 736         print("\n");
 737         print_version();
 738     }
 739     print(<<"END");
 740
 741 Usage: $progname [options]
 742
 743 Contains tests for the $CMDB(1) program.
 744
 745 Options:
 746
 747   -a, --all
 748     Run all tests, also TODOs.
 749   -h, --help
 750     Show this help.
 751   -q, --quiet
 752     Be more quiet. Can be repeated to increase silence.
 753   -t, --todo
 754     Run only the TODO tests.
 755   -v, --verbose
 756     Increase level of verbosity. Can be repeated.
 757   --version
 758     Print version information.
 759
 760 END
 761     exit($Retval);
 762     # }}}
 763 } # usage()
 764
 765 sub msg {
 766     # Print a status message to stderr based on verbosity level {{{
 767     my ($verbose_level, $Txt) = @_;
 768
 769     $verbose_level > $Opt{'verbose'} && return;
 770     print(STDERR "$progname: $Txt\n");
 771     return;
 772     # }}}
 773 } # msg()
 774
 775 __END__
 776
 777 # This program is free software; you can redistribute it and/or modify
 778 # it under the terms of the GNU General Public License as published by
 779 # the Free Software Foundation; either version 2 of the License, or (at
 780 # your option) any later version.
 781 #
 782 # This program is distributed in the hope that it will be useful, but
 783 # WITHOUT ANY WARRANTY; without even the implied warranty of
 784 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 785 # See the GNU General Public License for more details.
 786 #
 787 # You should have received a copy of the GNU General Public License
 788 # along with this program.
 789 # If not, see L<http://www.gnu.org/licenses/>.
 790
 791 # vim: set fenc=UTF-8 ft=perl fdm=marker ts=4 sw=4 sts=4 et fo+=w :