epics/pcas
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

tools: add assembleSnippets.pl and test

Browse Source
This commit is contained in:
Ralph Lange
2015-10-09 11:25:45 +02:00
parent c74eb27474
commit 4b9958304d
3 changed files with 225 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
src/tools/assembleSnippets.pl Normal file
View File

@@ -0,0 +1,131 @@
#!/usr/bin/env perl
#*************************************************************************
# Copyright (c) 2015 ITER Organization.
# EPICS BASE is distributed subject to a Software License Agreement found
# in file LICENSE that is included with this distribution.
#*************************************************************************
# $Id$
use strict;
use warnings;
use Getopt::Std;
use File::Basename;
use Data::Dumper;
our ($opt_o, $opt_d, $opt_m, $opt_i);
$Getopt::Std::OUTPUT_HELP_VERSION = 1;
&HELP_MESSAGE if !getopts('i:m:o:d') || @ARGV == 0;
my $out;
my %snippets;
my $ipattern;
my $datetime = localtime();
(my $user, my @dummy) = getpwuid($<);
my %replacements = (
_DATETIME_ => $datetime,
_USER_ => $user,
);
if ($opt_o) {
open $out, '>', $opt_o or
die "Can't create $opt_o: $!\n";
print STDERR "opened file $opt_o for output\n" if $opt_d;
} else {
open $out, '>&', STDOUT;
print STDERR "using STDOUT for output\n" if $opt_d;
}
if ($opt_m) {
foreach my $r (split /,/, $opt_m) {
(my $k, my $v) = split /=/, $r;
$replacements{$k} = $v;
}
}
if ($opt_i) {
$ipattern = qr($opt_i);
}
# %snippets is a hash {rank}
# of hashes {name-after-rank}
# of arrays[] [files...]
# of arrays[2] [filename, command]
print STDERR "reading input files\n" if $opt_d;;
foreach (@ARGV) {
my $name = basename($_);
if ($opt_i and not $name =~ /$ipattern/) {
print STDERR " snippet $_ does not match input pattern $opt_i - ignoring\n" if $opt_d;
next;
}
if ($name =~ /\A([ARD]?)([0-9]+)(.*[^~])\z/) {
print STDERR " considering snippet $_\n" if $opt_d;
if (exists $snippets{$2}) {
my %rank = %{$snippets{$2}};
my @files = @{ $rank{(keys %rank)[0]} };
my $existcmd = $files[0]->[1];
if ($1 eq "D" and $existcmd ne "D") {
print STDERR " ignoring 'D' default for existing rank $2\n" if $opt_d;
next;
} elsif ($1 eq "R") {
print STDERR " 'R' command - deleting existing rank $2 snippets\n" if $opt_d;
$snippets{$2} = {};
} elsif ($existcmd eq "D") {
print STDERR " deleting existing rank $2 default snippet\n" if $opt_d;
$snippets{$2} = {};
}
}
if ($opt_d) {
print STDERR " adding snippet ";
print STDERR "marked as default " if $1 eq "D";
print STDERR "to rank $2\n";
}
$snippets{$2}{$3} = () if (not exists $snippets{$2}{$3});
push @{$snippets{$2}{$3}}, [ $_, $1 ];
}
}
if ($opt_d) {
print STDERR "finished reading input files\n";
print STDERR "dumping the final snippet structure\n";
print STDERR Dumper(\%snippets);
print STDERR "dumping the macro replacements\n";
print STDERR Dumper(\%replacements);
print STDERR "creating output\n";
}
foreach my $r (sort {$a<=>$b} keys %snippets) {
print STDERR " working on rank $r\n" if $opt_d;
foreach my $n (sort keys %{$snippets{$r}}) {
foreach my $s (@{$snippets{$r}{$n}}) {
my $in;
my $f = $s->[0];
print STDERR " snippet $n from file $f\n" if $opt_d;
open $in, '<', $f or die "Can't open $f: $!\n";
while (<$in>) {
chomp;
foreach my $k (keys %replacements) {
s/$k/$replacements{$k}/g;
}
print $out $_, "\n";
}
close $in;
}
}
}
print STDERR "finished creating output, closing\n" if $opt_d;
close $out;
sub HELP_MESSAGE {
print STDERR "Usage: assembleSnippets.pl [options] snippets ...\n";
print STDERR "Options:\n";
print STDERR " -o file output file [STDOUT]\n";
print STDERR " -d debug mode [no]\n";
print STDERR " -m macros list of macro replacements as \"key=val,key=val\"\n";
print STDERR " -i pattern pattern for input files to match\n";
exit 2;
}

1
src/tools/test/Makefile
View File

@@ -18,6 +18,7 @@ TESTS += Menu
TESTS += Recfield
TESTS += Recordtype
TESTS += Registrar
TESTS += Snippets
TESTS += Variable
TESTSCRIPTS_HOST += $(TESTS:%=%.t)

93
src/tools/test/Snippets.plt Normal file
View File

@@ -0,0 +1,93 @@
#!/usr/bin/env perl
use File::Path;
use Test::More tests => 23;
(my $user, my @rest) = getpwuid($<);
mkdir "a$$";
mkdir "b$$";
sub mksnip {
my ($dir, $file, $line) = @_;
open(my $fh, '>', "$dir$$/$file") or die "can't open $dir$$/$file : $!";
print $fh $line;
close $fh;
}
sub assemble {
my @cmd = ( 'perl', '../../assembleSnippets.pl', '-o', "out$$" );
push @cmd, @_;
system(@cmd);
open(my $fh, '<', "out$$") or die "can't open out$$ : $!";
chomp(my @result = <$fh>);
close $fh;
return join (' ', @result);
}
# Adding two snippets of same rank, sorting alphabetically
mksnip('a', '10_a', '10');
mksnip('b', '10_c', '12');
is assemble("a$$/10_a", "b$$/10_c"), '10 12', "adding same rank; ordered";
is assemble("b$$/10_c", "a$$/10_a"), '10 12', "adding same rank; reverse order";
# Same, with 'A' cmd
mksnip('a', 'A10_a', '10');
mksnip('b', 'A10_c', '12');
is assemble("a$$/10_a", "b$$/A10_c"), '10 12', "'A' add same rank; ordered";
is assemble("b$$/10_c", "a$$/A10_a"), '10 12', "'A' add same rank; reverse order";
# Same name does not create issues
mksnip('b', '10_a', '10x');
is assemble("a$$/10_a", "b$$/10_a"), '10 10x', "adding same name twice; order a-b";
is assemble("b$$/10_a", "a$$/10_a"), '10x 10', "adding same name twice; order b-a";
# Backup files (trailing ~) and hidden files (leading '.') get ignored
mksnip('b', '10_c~', '12~');
mksnip('b', '.10_c', '.12');
is assemble("b$$/10_c", "b$$/10_c~"), '12', "backup file (trailing ~) gets ignored";
is assemble("b$$/10_c", "b$$/.10_c"), '12', "hidden file (leading .) gets ignored";
# Non-numeric filenames get ignored
mksnip('a', 'foo10_a', 'foo10');
is assemble("b$$/10_c", "a$$/foo10_a"), '12', "file starting with [^ADR0-9] gets ignored";
# 'R' command replaces existing snippets of same rank
mksnip('a', 'R10_b', '11');
is assemble("a$$/10_a", "b$$/10_c", "a$$/R10_b"), '11', "'R' cmd; replace all";
is assemble("a$$/10_a", "a$$/R10_b", "b$$/10_c"), '11 12', "'R' cmd; replace one (ordered)";
is assemble("b$$/10_c", "a$$/R10_b", "a$$/10_a"), '10 11', "'R' cmd; replace one (reverse order)";
# 'D' command establishes default that gets overwritten or ignored
mksnip('a', 'D10_a', 'D10');
mksnip('b', 'D10_c', 'D12');
is assemble("a$$/D10_a", "b$$/10_c"), '12', "'D' default; replaced by regular";
is assemble("a$$/D10_a", "b$$/D10_c"), 'D12', "'D' default; replaced by new default (ordered)";
is assemble("b$$/D10_c", "a$$/D10_a"), 'D10', "'D' default; replaced by new default (reverse order)";
is assemble("a$$/D10_a", "a$$/R10_b"), '11', "'D' default; replaced by 'R' cmd";
is assemble("b$$/10_c", "a$$/D10_a"), '12', "'D' default; ignored when regular exists";
# Ranks are sorted numerically
mksnip('b', '09_a', '09');
mksnip('a', '15_a', '15');
mksnip('b', '2_a', '2');
is assemble("a$$/10_a", "b$$/2_a", "a$$/15_a", "b$$/09_a"), '2 09 10 15', "ranks are sorted numerically";
# Builtin macros
mksnip('a', '30_a', '_USER_');
is assemble("a$$/30_a"), "$user", "builtin macro _USER_";
# User macros
mksnip('b', '35_a', 'Line _M1_');
mksnip('b', '35_b', 'Line _M1_ with _M2_');
mksnip('b', '35_c', 'Line _M2_ with _M2_');
is assemble("-m", "_M1_=REP1", "b$$/35_a"), "Line REP1", "single user macro; single occurrence";
is assemble("-m", "_M1_=REP1,_M2_=REP2", "b$$/35_b"), "Line REP1 with REP2", "multiple user macros";
is assemble("-m", "_M2_=REP2", "b$$/35_c"), "Line REP2 with REP2", "single user macro; multiple occurrences";
# Input pattern
mksnip('a', '10_a.cmd', '10cmd');
is assemble("-i", "\.cmd", "a$$/10_a", "b$$/10_c", "a$$/R10_b", "a$$/10_a.cmd"), '10cmd', "'input pattern";
rmtree([ "a$$", "b$$", "out$$" ]);