1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178 | -- -*- coding: utf-8 -*-
--
-- ZanyBlue, an Ada library and framework for finite element analysis.
--
-- Copyright (c) 2012, 2016, Michael Rohan <mrohan@zanyblue.com>
-- All rights reserved.
--
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions
-- are met:
--
-- * Redistributions of source code must retain the above copyright
-- notice, this list of conditions and the following disclaimer.
--
-- * Redistributions in binary form must reproduce the above copyright
-- notice, this list of conditions and the following disclaimer in the
-- documentation and/or other materials provided with the distribution.
--
-- * Neither the name of ZanyBlue nor the names of its contributors may
-- be used to endorse or promote products derived from this software
-- without specific prior written permission.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-- HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
-- TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--
-- @usage nextlog [ -c counter ] [ -n ]
-- @summary return the name of next number log file
-- @start-doc
-- The "nextlog" function returns the next log name for the current test
-- based on a sequence controlled by the "_lognum" parameter. By default,
-- an undo action is also created to compare the generated log name with a
-- reference log file on exiting the test scope. The undo action creation
-- is suppressed if the "-n" option is given. The format of the log file
-- name generated is::
--
-- TESTNAME-nn.log
--
-- where "TESTNAME" is the name of the current test and "nn" the sequence
-- number. The use of the "nextlog" function can simplify test scripts,
-- e.g.,::
--
-- execute -o mytest-01.log mycmd1
-- execute -o mytest-02.log mycmd2
-- compare mytest-01.log
-- compare mytest-02.log
--
-- can be re-written as::
--
-- execute -o $(nextlog) mycmd1
-- execute -o $(nextlog) mycmd2
--
-- The "-c" option can be used to start a new log naming sequence for log
-- files that are not part of the normal test reference logs, e.g., the output
-- of the build commands to generate an executable are too platform specific
-- to to be used as reference log files but the output should be stored in a
-- log file for debugging. The argument to the "-c" option is the name of
-- an integer parameter which is used to sequence the log file name (the
-- parameter is created if it does not already exist in the current scope).
--
-- By default, log file using alternative counter names do not create
-- undo actions to execute the compare command. If the log files should
-- be compared on scope exit, the "-n" option can be used.
--
-- For example, save the output of a build command::
--
-- execute -o $(nextlog -c build) build.sh
--
-- would generate the log file TESTNAME-build-nn.log, the counter name
-- is embedded in the log file.
--
with Ada.Strings.Wide_Fixed;
separate (ZBTest.Functions)
function Nextlog_Function
(State : access State_Type;
Args : List_Type)
return String
is
use Ada.Strings.Wide_Fixed;
function Counter_Log_Name
(State : access State_Type;
Counter_Name : String;
With_Undo : Boolean)
return String;
function Log_Name
(State : access State_Type;
Base_Name : String;
Log_Num : Positive;
With_Undo : Boolean)
return String;
----------------------
-- Counter_Log_Name --
----------------------
function Counter_Log_Name
(State : access State_Type;
Counter_Name : String;
With_Undo : Boolean)
return String
is
Test_Name : constant String := State.Get_String ("_testname");
begin
if Counter_Name'Length = 0 or else Head (Counter_Name, 1) = "_" then
raise Function_Usage_Error;
end if;
if not State.Is_Defined (Counter_Name) then
State.Set_Integer (Counter_Name, 0);
end if;
State.Increment (Counter_Name, Deep => False);
return
Log_Name
(State, Test_Name & "-" & Counter_Name,
State.Get_Integer (Counter_Name), With_Undo);
end Counter_Log_Name;
--------------
-- Log_Name --
--------------
function Log_Name
(State : access State_Type;
Base_Name : String;
Log_Num : Positive;
With_Undo : Boolean)
return String
is
Result : constant String :=
Format ("{0}-{1,=2}.log", +Base_Name, +Log_Num);
begin
if With_Undo then
State.Add_Undo_Action ("compare " & Result);
end if;
return Result;
end Log_Name;
Counter_Index : Natural := 0;
With_Undo : Boolean := True;
Index : Positive := 2;
begin
while Index <= Length (Args) loop
if Value (Args, Index) = "-n" then
With_Undo := not With_Undo;
elsif Value (Args, Index) = "-c" and then Index < Length (Args) then
Index := Index + 1;
Counter_Index := Index;
With_Undo := not With_Undo;
else
raise Function_Usage_Error;
end if;
Index := Index + 1;
end loop;
if Counter_Index /= 0 then
return Counter_Log_Name (State, Value (Args, Counter_Index), With_Undo);
else
State.Increment ("_lognum", Deep => False);
return
Log_Name
(State, State.Get_String ("_testname"),
State.Get_Integer ("_lognum"), With_Undo);
end if;
end Nextlog_Function;
|