t/codingstd/c_todo.t

   1 #! perl
   2 # Copyright (C) 2006-2009, Parrot Foundation.
   3 # $Id$
   4
   5 use strict;
   6 use warnings;
   7 use lib qw( . lib ../lib ../../lib );
   8 use Test::More tests => 1;
   9 use Parrot::Distribution;
  10
  11 =head1 NAME
  12
  13 t/codingstd/c_todo.t - checks for "FIXME" and similar notes in C source and headers
  14
  15 =head1 SYNOPSIS
  16
  17     # test all files
  18     % prove t/codingstd/c_todo.t
  19
  20     # test specific files
  21     % perl t/codingstd/c_todo.t src/foo.c include/parrot/bar.h
  22
  23 =head1 DESCRIPTION
  24
  25 Checks that no C source or header file in the distribution contains the
  26 following strings:
  27
  28     FIXME
  29     TODO
  30     XXX
  31
  32 =head1 SEE ALSO
  33
  34 L<docs/pdds/pdd07_codingstd.pod>
  35
  36 =cut
  37
  38 my $DIST = Parrot::Distribution->new;
  39 my @files = @ARGV ? <@ARGV> : $DIST->get_c_language_files();
  40 my @fixme;
  41 my %failed_files;
  42
  43 foreach my $file (@files) {
  44
  45     # if we have command line arguments, the file is the full path
  46     # otherwise, use the relevant Parrot:: path method
  47     my $path = @ARGV ? $file : $file->path;
  48
  49     open my $fh, '<', $path
  50         or die "Cannot open '$path' for reading: $!\n";
  51
  52     while (<$fh>) {
  53         next unless /(FIXME|XXX|TODO)/;
  54
  55         push @fixme, "file '$path', line $.: $1\n";
  56         $failed_files{$path}++;
  57     }
  58     close $fh;
  59 }
  60
  61 my $num_failed_files = scalar keys %failed_files;
  62 TODO: {
  63     local $TODO = scalar(@fixme) . ' todos remain';
  64
  65 ok( !scalar(@fixme), 'FIXME strings' )
  66     or diag( "FIXME strings found in "
  67         . scalar @fixme
  68         . " instances in "
  69         . $num_failed_files
  70         . " files:\n@fixme" );
  71 }
  72
  73 # Local Variables:
  74 #   mode: cperl
  75 #   cperl-indent-level: 4
  76 #   fill-column: 100
  77 # End:
  78 # vim: expandtab shiftwidth=4: