Module: GoodData::Bam::Validators

Includes:
GoodData::Bam, CloudConnect
Defined in:
lib/generators/validators.rb

Constant Summary

Constants included from GoodData::Bam

BAM_DEFINED_GRAPHS_ROOT, BAM_ROOT, GENERATOR_ROOT, REPO_ROOT, TEMPLATE_ROOT

Class Method Summary collapse

Methods included from GoodData::Bam

flow

Class Method Details

.backup_files_from_glob(file, options = {}) ⇒ Object 



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
 
# File 'lib/generators/validators.rb', line 27

def self.backup_files_from_glob(file, options={})
  files_to_backup = Array(options[:files_to_backup])
  remote_url = options[:remote_url]
  File.open(file, "w") do |f|

    builder = Builder::XmlMarkup.new(:target=>f, :indent=>2)
    builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
    builder.Graph({
      :name => "Contract Checker: File list reader"
    }) do
      builder.Global do
        CloudConnect::Helpers::property_file(builder, {:id => "workspace_params", :fileURL => "workspace.prm"})
        CloudConnect::Helpers::property_file(builder, {:id => "now_params", :fileURL => "now.prm"})

        CloudConnect::Helpers::create_trash_meta(builder)
        CloudConnect::Helpers::create_file_list_meta(builder)

      end

      builder.Phase(:number => 1) do
        ctl = "function integer generate() {$out.0.all = 'Just creating this file';return OK;}"
        Core::build_node2(builder, Nodes.data_generator2({:name => "generate", :id => "generate", :generate => ctl}))
        Core::build_node2(builder, Nodes.edge2({:toNode => "create_dir:0", :fromNode => "generate:0", :metadata => "trash_metadata"}))
        Core::build_node2(builder, Nodes.writer2({
          :fileURL => remote_url + "touch.txt",
          :name => "create_dir",
          :id => "create_dir"
          }))
      end
      phase = 2

      files_to_backup.each do |file_to_backup|
        builder.Phase(:number => phase += 1) do
          Core::build_node2(builder, Nodes.backup2({
            :baseURL => remote_url,
            :sourcePath => file_to_backup,
            :name => "Backup",
            :id => "backup",
            :mode => "DO_NOT_COMPRESS"
            }))
        end
      end
    end
  end
end

.ctl_validation(name, validation) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/generators/validators.rb', line 8

def self.ctl_validation(name, validation)
  ctl = case validation[:type]
  when "integer"
    "!matches($in.0.#{name}, \"^[0-9]+$\")"
  when "decimal"
    "!isNumber($in.0.#{name})"
  when "url"
    "!isUrl($in.0.#{name})"
  when "date"
    "!isDate($in.0.#{name}, \"#{validation[:format]}\")"
  else
    fail "Uknown validation type \"#{validation[:type]}\""
  end

  format = validation[:format] || ''

  "fieldName = \"#{name}\";\nvalidationType = \"#{validation[:type]}\";\nif (" + ctl + ") {currentLineFailed = true;failed = true;$out.1.all = \"Error in file '${FILE}' on line \" + line + \" at field \" + fieldName + \". Expected \" + validationType + \" #{format} got '\" + currentValue + \"'\";};"
end

.generate_checker_file_list(file, taps) ⇒ Object 



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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/generators/validators.rb', line 133

def self.generate_checker_file_list(file, taps)
  File.open(file, "w") do |f|

    builder = Builder::XmlMarkup.new(:target=>f, :indent=>2)
    builder.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
    builder.Graph({
      :name => "Contract Checker: File list reader"
    }) do
      builder.Global do
        CloudConnect::Helpers::property_file(builder, {:id => "workspace_params", :fileURL => "workspace.prm"})

        CloudConnect::Helpers::create_trash_meta(builder)
        CloudConnect::Helpers::create_run_graph_failure_metadata(builder)

        builder.Metadata({:id => "file_list"}) do |builder|
          CloudConnect::Helpers::csv_metadata(builder, {
            :name   => "file_list",
            :fields => [
              {:name => "filePath", :type => "string"},
              {:name => "fileName", :type => "string"}
            ]
          })
        end
      end

      reformat_func = <<HEREDOC

function integer transform() {
    $out.0.filePath = replace($in.0.filePath, "${GDC_WEBDAV_HOST}", replace(replace(\"${GD_LOGIN}\",\"@\",\"%40\"),\"\\\\+\",\"%2B\") + ":${GD_PASSWORD}@${GDC_WEBDAV_HOST}");
    $out.0.fileName = $in.0.fileName;
    return ALL;
}
HEREDOC

      i = 0

      builder.Phase(:number => i += 1) do
        Core::build_node2(builder, Nodes.data_generator2({:name => "now_generator", :id => "now_generator", :generate => "function integer generate() {$out.0.all = \"NOW=\" + toString(date2long(today()));return OK;}"}))
        Core::build_node2(builder, Nodes.writer2({:name => "NOW Writer", :id => "now_csv_writer", :fileURL => "now.prm", :outputFieldNames => "false", :quotedStrings => "false"}))
        Core::build_node2(builder, Nodes.edge2({:toNode => "now_csv_writer:0", :fromNode => "now_generator:0", :metadata => "trash_metadata"}))
      end

      taps.each do |tap|
        source = tap[:source]
        id =  tap[:id]

        builder.Phase(:number => i += 1) do
          #Core::build_node2(builder, Nodes.file_list2({:id => "#{id}_file_list", :name => "#{id}_file_list", :dataPolicy => "Strict", :baseURL => "#{tap[:validation_source]}", :output_mapping => Nodes::MAP_ALL}))
          Core::build_node2(builder, Nodes.reader2({:id => "#{id}_file_list", :name => "#{id}_file_list", :fileURL => "${gdc_agent_file}" }))
          Core::build_node2(builder, Nodes.reformat2({:name => "#{id} Reformat", :id => "#{id}_reformat", :transformation => reformat_func}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_reformat:0", :fromNode => "#{id}_file_list:0", :metadata => "file_list"}))
          Core::build_node2(builder, Nodes.writer2({:name => "PARAMS CSV Writer", :id => "#{id}_writer", :fileURL => "data/#{id}_files_to_read.csv"}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_writer:0", :fromNode => "#{id}_reformat:0", :metadata => "file_list"}))
        end

        builder.Phase(:number => i += 1) do
          ctl = "function integer generate() {$out.0.all = \"#{id}_SKIP_LINES=0\";return OK;}"
          Core::build_node2(builder, Nodes.data_generator2({:name => "#{id}_generator", :id => "#{id}_generator", :generate => ctl}))
          Core::build_node2(builder, Nodes.writer2({:name => "PARAMS CSV Writer", :id => "#{id}_csv_writer", :fileURL => "#{id}_counter.prm", :outputFieldNames => "false", :quotedStrings => "false"}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_csv_writer:0", :fromNode => "#{id}_generator:0", :metadata => "trash_metadata"}))
        end

        subgraph_reformat_func = <<HEREDOC

function integer transform() {
    $out.0.all = "graphs/#{id}_loop.grf";  
    return ALL;
}
HEREDOC

      fail_reformat = <<HEREDOC
function integer transform() {
  raiseError("Loop failed");
}
HEREDOC


        builder.Phase(:number => i += 1) do
          Core::build_node2(builder, Nodes.reformat2({:name => "#{id} Reformat graph", :id => "#{id}_reformat_graph", :transformation => subgraph_reformat_func}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_reformat_graph:0", :fromNode => "#{id}_reformat:1", :metadata => "file_list"}))
          Core::build_node2(builder, Nodes.run_graph2({
            :guiName => id,
            :name => id,
            :id => "#{id}_run_graph"
          }))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_run_graph:0", :fromNode => "#{id}_reformat_graph:0", :metadata => "trash_metadata"}))
          Core::build_node2(builder, Nodes.reformat2({:name => "#{id} Reformat fail", :id => "#{id}_reformat_fail", :transformation => fail_reformat}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_reformat_fail:0", :fromNode => "#{id}_run_graph:1", :metadata => "run_graph_failure_metadata"}))
          Core::build_node2(builder, Nodes.trash2({:name => "#{id}_trash", :id => "#{id}_trash", :debugPrint => true}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_trash:0", :fromNode => "#{id}_reformat_fail:0", :metadata => "run_graph_failure_metadata"}))
        end
      end

      # If there is a fail.
      # Copies the report files
      taps.each do |tap|
        id = tap[:id]
        builder.Phase(:number => i += 1) do
          Core::build_node2(builder, Nodes.reader2({
            :id => "#{id}_files_copy_check_reader",
            :guiName => "#{id}_files failure_check_reader",
            :name => "#{id}_files_failure_check_reader",
            :fileURL => "data/has_errors_*.csv",
            :skipRows => 0,
            :numRecords => 1
          }))

        fail_reformat = <<HEREDOC
function integer transform() {
  $out.0.all = "graphs/#{id}_failure.grf";
  return ALL;
}
HEREDOC

          Core::build_node2(builder, Nodes.reformat2({:name => "#{id}_files_copy_check_reformat", :id => "#{id}_files_copy_check_reformat", :transformation => fail_reformat}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_files_copy_check_reformat:0", :fromNode => "#{id}_files_copy_check_reader:0", :metadata => "trash_metadata"}))

          Core::build_node2(builder, Nodes.run_graph2(
            {
              :guiName => "#{id}_failure_run_graph",
              :name => "#{id}_failure_run_graph",
              :id => "#{id}_failure_run_graph"
            }))

          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_failure_run_graph:0", :fromNode => "#{id}_files_copy_check_reformat:0", :metadata => "trash_metadata" }))
        end
      end

      # If there was a failure
      # Kill the graph
      builder.Phase(:number => i += 1) do
        Core::build_node2(builder, Nodes.reader2({
          :id => "failure_check_reader",
          :guiName => "failure_check_reader",
          :name => "failure_check_reader",
          :fileURL => "data/has_errors_*.csv",
          :skipRows => 0
        }))

        failure_func = <<HEREDOC

function integer transform() {
    raiseError("Validation did not pass");
}
HEREDOC
        Core::build_node2(builder, Nodes.reformat2({:name => "failure_dedup", :id => "failure_dedup", :transformation => failure_func }))
        Core::build_node2(builder, Nodes.edge2({:toNode => "failure_dedup:0", :fromNode => "failure_check_reader:0", :metadata => "trash_metadata" }))

        Core::build_node2(builder, Nodes.trash2({:name => "failure_check_trash", :id => "failure_check_trash", :debugPrint => true}))
        Core::build_node2(builder, Nodes.edge2({:toNode => "failure_check_trash:0", :fromNode => "failure_dedup:0", :metadata => "trash_metadata" }))
      end

      # If everything is success.
      # Copies the files
      taps.each do |tap|
        builder.Phase(:number => i += 1) do

          Core::build_node2(builder, Nodes.run_graph2(
            {
              :guiName => "success_run_graph",
              :name => "success_run_graph",
              :id => "success_run_graph",
              :graphName => "graphs/#{tap[:id]}_success.grf"
            }))
        end
      end
    end
  end
end

.generate_checker_success(file, tap) ⇒ Object 



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
 
# File 'lib/generators/validators.rb', line 73

def self.generate_checker_success(file, tap)
  id =  tap[:id]
  File.open(file, "w") do |f|

    builder = Builder::XmlMarkup.new(:target=>f, :indent=>2)
    builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
    builder.Graph({
      :name => "Contract Checker: File list reader"
    }) do
      builder.Global do
        CloudConnect::Helpers::property_file(builder, {:id => "workspace_params", :fileURL => "workspace.prm"})

        CloudConnect::Helpers::create_trash_meta(builder)

        builder.Metadata({:id   => "file_list"}) do |builder|
          CloudConnect::Helpers::csv_metadata(builder, {
            :name   => "file_list",
            :fields => [
              {:name => "filePath", :type => "string"},
              {:name => "fileName", :type => "string"}
            ]
          })
        end
      end

      builder.Phase(:number => 0) do
        Core::build_node2(builder, Nodes.reader2({
          :id => "#{id}_reader",
          :guiName => "#{id}_reader",
          :name => "#{id}_reader",
          :dataPolicy => "Strict",
          :skipRows => 0,
          :fileURL => "data/#{id}_files_to_read.csv"
        }))

        reformat_func = <<HEREDOC
function integer transform() {
  //$out.0.filePath = replace($in.0.filePath, ':file', '');
  $out.0.filePath = chop($in.0.filePath, $in.0.fileName);
  $out.0.fileName = $in.0.fileName;  
  return ALL;
}
HEREDOC
        Core::build_node2(builder, Nodes.reformat2({:name => "#{id} Reformat_graph", :id => "#{id}_reformat", :transformation => reformat_func }))
        Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_reformat:0", :fromNode => "#{id}_reader:0", :metadata => "file_list" }))

        Core::build_node2(builder, Nodes.file_copy2({
          :baseURL => "${filePath}",
          :sourcePath => "${fileName}",
          :name => "#{id} Backup",
          :id => "#{id}_backup",
          :operation => "MOVE",
          :targetPath => "validated/"
          }))
        Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_backup:0", :fromNode => "#{id}_reformat:0", :metadata => "file_list" }))
      end
    end
  end
end

.generate_contract(file, tap) ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/generators/validators.rb', line 303

def self.generate_contract(file, tap)
  name = id = tap[:id]

  File.open(file, "w") do |f|

    builder = Builder::XmlMarkup.new(:target=>f, :indent=>2)
    builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
    builder.Graph({
      :name => "Contract Checker"
    }) do
      builder.Global do
        CloudConnect::Helpers::property_file(builder, {:id => "workspace_params", :fileURL => "workspace.prm"})
        CloudConnect::Helpers::property_file(builder, {:id => "file_params", :fileURL => "#{id}_item.prm"})

        CloudConnect::Helpers::create_trash_meta(builder)
        CloudConnect::Helpers::create_read_error_meta(builder)

        builder.Metadata({:id   => "#{name}_clover_metadata"}) do |builder|
          CloudConnect::Helpers::csv_metadata(builder, Metadata.get_source_metadata(tap))
        end
      end

      builder.Phase(:number => 0) do


          reformat_func = <<HEREDOC
long line = 0;
string fieldName;
string validationType;
string currentValue;
boolean failed;
boolean currentLineFailed;

function integer transform() {
  line = line + 1;
  currentLineFailed = false;

  #{tap[:fields].find_all {|d| d.has_key?(:validates_as)}.map do |d|
    "currentValue = $in.0." + d[:name] + ";" + ctl_validation(d[:name], d[:validates_as])
  end.join("\n")}
  if (currentLineFailed) {
    return 1;
  } else {
    return 0;
  }
}

HEREDOC


          has_error_reformat_func = <<HEREDOC
function integer transform() {
  $out.0.all = "${FILE}";  
  return ALL;
}

HEREDOC

        format_clover_error = <<HEREDOC
function integer transform() {
  $out.0.all = "Parsing error occured on line " + $in.0.line_number + " of file " + $in.0.file + " on record " + $in.0.record + " with message " + $in.0.message ;
  return ALL;
}

HEREDOC

          Core::build_node2(builder, Nodes.reader2({:id => "#{id}_reader", :name => "#{id}_reader", :dataPolicy => "controlled", :fileURL => "${FILE}"}))
          Core::build_node2(builder, Nodes.reformat2({:name => "#{id} Reformat", :id => "#{id}_reformat", :transformation => reformat_func}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_reformat:0", :fromNode => "#{id}_reader:0", :metadata => "#{id}_clover_metadata"}))

          Core::build_node2(builder, Nodes.reformat2({:name => "#{id} reader error Reformat", :id => "#{id}_reader_error_reformat", :transformation => format_clover_error}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_reader_error_reformat:0", :fromNode => "#{id}_reader:1", :metadata => "reader_error_metadata"}))

          Core::build_node2(builder, Nodes.gather2({:name => "#{id} Gather", :id => "#{id}_gather"}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_gather:1", :fromNode => "#{id}_reader_error_reformat:0", :metadata => "trash_metadata"}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_gather:0", :fromNode => "#{id}_reformat:1", :metadata => "trash_metadata"}))

          Core::build_node2(builder, Nodes.trash2({:name => "PARAMS CSV Writer", :id => "#{id}_trash", :debugPrint => false }))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_trash:0", :fromNode => "#{id}_reformat:0", :metadata => "trash_metadata"}))

          Core::build_node2(builder, Nodes.copy2({:name => "#{id} copy", :id => "#{id}_copy"}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_copy:0", :fromNode => "#{id}_gather:0", :metadata => "trash_metadata"}))

          Core::build_node2(builder, Nodes.writer2({:name => "PARAMS CSV Writer", :id => "#{id}_writer", :fileURL => "data/validation_output_#{id}.csv", :outputFieldNames => "false", :append => "true", :quotedStrings => "true"}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_writer:0", :fromNode => "#{id}_copy:0", :metadata => "trash_metadata", :append => true}))

          Core::build_node2(builder, Nodes.reformat2({:name => "#{id} Reformat", :id => "#{id}_has_error_reformat", :transformation => has_error_reformat_func}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_has_error_reformat:0", :fromNode => "#{id}_copy:1", :metadata => "trash_metadata"}))

          Core::build_node2(builder, Nodes.writer2({:name => "PARAMS CSV Writer", :id => "#{id}_has_error_writer", :fileURL => "data/has_errors_#{id}.csv", :outputFieldNames => "false", :append => "true", :quotedStrings => "false"}))
          Core::build_node2(builder, Nodes.edge2({:toNode => "#{id}_has_error_writer:0", :fromNode => "#{id}_has_error_reformat:0", :metadata => "trash_metadata"}))
        end
    end
  end
end