summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/proposal/bin/generate-issues
blob: 84ebfd80fd6c74186028fccade30d21e7d72883b (plain)
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
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
302
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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
#!/usr/bin/env ruby
# Generate GitHub Issues for tasks and deliverables
# - Each work package gets a WPX/README.md file
# - Each task gets an Issue
# - Each deliverable gets a Milestone
# - Each deliverable gets an Issue associated with its Milestone
# - Each deliverable Issue gets 'deliverable', 'WPX' tags
# - Each task Issue gets 'task', 'WPX' tags

# Run me from the proposal dir containing proposal.pdata:
# cd ~/OpenDreamKit/Proposal
# ~/path/to/LaTeX-Proposal/bin/generate-issues

require 'date'
require 'Octokit'
require 'netrc'

# constants for running the script are for OpenDreamKit
# update these for your own proposal

START_DATE = Date::new(2015, 9, 1) # start date of the project
HOMEPAGE = "http://opendreamkit.org"
PROPOSAL_URL = "https://github.com/OpenDreamKit/OpenDreamKit/raw/master/Proposal/proposal-www.pdf"
PROJECT = "OpenDreamKit"
REPO = "OpenDreamKit/OpenDreamKit"
TARGET = "final" # or 'proposal'

# throttle github creation requests to 5 Hz to avoid getting flagged for abuse
THROTTLE_SECONDS = 5

NATURES = {
  'R'     => 'Report',
  'DEM'   => 'Demonstrator',
  'DEC'   => 'Websites, Media, etc.',
  'OTHER' => 'Other',
}

DISSEMINATIONS = {
  'PU' => 'Public',
  'CO' => 'Confidential',
  'CI' => 'Classified',
}

SITES = {
  'PS'  => 'Université Paris-Sud',
  'LL'  => 'Logilab',
  'UV'  => 'Université de Versailles Saint-Quentin',
  'UJF' => 'Université Joseph Fourier',
  'UB'  => 'CNRS',
  'UO'  => 'University of Oxford',
  'USH' => 'University of Sheffield',
  'USO' => 'University of Southampton',
  'SA'  => 'University of St Andrews',
  'UW'  => 'University of Warwick',
  'JU'  => 'Jacobs University Bremen',
  'UK'  => 'University of Kaiserslautern',
  'US'  => 'University of Silesia',
  'ZH'  => 'Universität Zürich',
  'SR'  => 'Simula Research Laboratory',
}

REVERSE_SITES = {}
SITES.each_pair do |key, name|
  REVERSE_SITES[name] = key
end

# Some sites would prefer alternative abbreviations
REVERSE_SITES['University of St Andrews'] = 'USTAN'
REVERSE_SITES['Université de Versailles Saint-Quentin'] = 'UVSQ'

#------------------- Parsing proposal.pdata ---------------------

def split_line(line)
  # super primitive state-machine line split (not going to regex this)
  parts = []
  level = 0
  buffer = []
  line.each_char do |c|
    case c
    when '{'
      if level > 0
        buffer.push c
      end
      level += 1
    when '}'
      level -= 1
      if level > 0
        buffer.push c
      end
      if level == 0
        parts.push(scrub_tex(buffer.join('')))
        buffer = []
      end
    else
      if level > 0
        buffer.push c
      end
    end
  end
  return parts
end


def scrub_tex(text)
  # scrub some latex markup from text
  text.gsub!(/\\\w+/, '')
  text.gsub!(/[{}]/, '')
  text.strip.split.join(' ')
end


def transform_value(key, value)
  case key
  when 'lead'
    return SITES[value]
  when 'partners'
    return value.split(',').map { |v| SITES[v] }
  when 'dissem'
    return DISSEMINATIONS[value]
  when 'nature'
    return NATURES[value]
  when 'month'
    return value.to_i
  when 'delivs'
    return value.split(',')
  else
    return scrub_tex(value)
  end
end


def load_pdata(proposal_dir)
  pdata = File.join(proposal_dir, "#{TARGET}.pdata")
  deliv_data = File.join(proposal_dir, "#{TARGET}.deliverables")
  
  workpackages = {} # mapping of workpackage id => wp info
  deliverables = {}
  
  File.readlines(pdata).each do |line|
    key, *args = split_line line
  
    case key
    when 'wp'
      name, key, value = args
      value = transform_value(key, value)
      if not workpackages.include? name
        workpackages[name] = {
          "tasks" => {},
          "unknown-task" => nil,
          "deliverables" => [],
        }
      end
      wp = workpackages[name]
      wp[key] = value

    when 'task'
      name, key, value = args
      value = transform_value(key, value)
      # find my workpackage
      if name.index('@')
        wpkey, short_name = name.split('@')
        if short_name.match(/task\d+/)
          workpackages[wpkey]['unknown-task'] = short_name
          name = short_name
        end
      else
        wpkey = workpackages.keys.select { |wpkey| name.start_with? wpkey }.first
      end
      # handle workpackage@taskNN weirdness
      wp = workpackages[wpkey]
      tasks = wp['tasks']
      if not wp['unknown-task'].nil? and wp['unknown-task'] != name
        tasks[name] = tasks.delete(wp['unknown-task'])
        wp['unknown-task'] = nil
      end
      if not tasks.include? name
        tasks[name] = {}
      end
      tasks[name][key] = value
    when 'deliv'
      name, key, value = args
      
      value = transform_value(key, value)
      if not deliverables.include? name
        deliverables[name] = {}
      end
      deliverables[name][key] = value

    else
      # DEBUG:
      # puts "    Ignored: #{args}"
    end
  end
  
  # get deliverable data, workpackage id from proposal.deliverables
  File.readlines(deliv_data).each do |line|
    args = split_line line
    name = args[3]
    if deliverables.include? name
      deliverable = deliverables[name]
    else
      deliverable = {}
    end
    month = args[0].to_i
    deliverable = (deliverables[name] or {}).merge({
      "month" => month,
      # due date is last day of the given month, so subtract one day
      "due_date" => (START_DATE >> month) - 1,
      "label" => scrub_tex(args[2]),
      "deliv_id" => args[3],
      "dissem" => transform_value('dissem', args[4]),
      "nature" => transform_value('nature', args[5]),
      "title" => scrub_tex(args[6]),
      "lead" => SITES[scrub_tex(args[8])],
    })
    wpid = scrub_tex(args[7])
    wp = workpackages.values.find {|wp| wp['label'] == wpid}
    wp['deliverables'].push(deliverable)
  end
  
  workpackages.values.each do |wp|
    wp['deliverables'].sort_by! {|d| d['label']}
  end
  
  return workpackages.values.sort_by {|wp| wp['label']}
end


#--------------- GitHub-related ---------------------

def check_token
  # get GitHub auth token, creating one if we don't find it.
  rc = Netrc.read Netrc.default_path
  if not rc['api.github.com'].nil?
    return
  end
  puts "We need your password to generate an OAuth token. The password will not be stored."
  username = ask "Username: "
  password = ask("Password:  ") { |q| q.echo = '*' }
  client = Octokit::Client.new(
    :login => username,
    :password => password,
  )
  reply = client.create_authorization(
    :scopes => ["public_repo"],
    :note => "Issue Migration",
  )
  token = reply.token
  rc['api.github.com'] = username, token
  rc.save
end

$cache = {
  'issues' => {},
  'milestones' => {},
}

def get_issues(github, repo)
  # get issues for a repo (cached)
  cache = $cache['issues']
  if not cache.include? repo
    cache[repo] = github.issues(repo)
  end
  return cache[repo]
end

def get_milestones(github, repo)
  # get issues for a repo (cached)
  cache = $cache['milestones']
  if not cache.include? repo
    cache[repo] = github.list_milestones(repo)
  end
  return cache[repo]
end

# Templates for making readmes, issues

README_TPL = <<-END
# %{title}

Lead Institution: %{lead}

See page %{page} of the [proposal](#{PROPOSAL_URL}) for the full description.
END

TASK_TPL = <<-END
- **%{wplabel}:** [%{wptitle}](https://github.com/#{REPO}/tree/master/%{wplabel})
- **Lead Institution:** %{lead}
- **Partners:** %{partners}
- **Work phases:** %{wphases}

See page %{page} of the [proposal](#{PROPOSAL_URL}) for the full description.
END

DELIV_TPL = <<-END
- **%{wplabel}:** [%{wptitle}](https://github.com/#{REPO}/tree/master/%{wplabel})
- **Lead Institution:** %{lead}
- **Due:** %{date} (month %{month})
- **Nature:** %{nature}

See page %{page} of the [proposal](#{PROPOSAL_URL}) for the full description.
END

DELIV_MILESTONE_TPL = "# %{title}\n\n#{DELIV_TPL}"


def make_task_issue(github, repo, task, workpackage, options)
  title = "#{task['label']}: #{task['title']}"
  issues = get_issues(github, repo)
  issue = issues.find { |i| i.title.start_with?(task['label'] + ':') }
  if issue.nil?
    body = TASK_TPL % {
      wplabel: workpackage['label'],
      wptitle: workpackage['title'],
      lead: task['lead'],
      page: task['page'],
      wphases: task['wphases'],
      partners: (task['partners'] or ['None']).join(', ')
    }
    puts "\n\nMaking Issue on #{repo}: #{title}"
    puts body
  
    github.create_issue(repo, title, body, options)
    # throttle creation calls to avoid flags for abuse
    sleep THROTTLE_SECONDS
  else
    puts "Found Issue #{repo}##{issue.number}: #{issue.title}"
    existing_labels = issue.labels.map { |label| label['name']}
    missing_labels = options[:labels].reject { |label| existing_labels.include? label }
    if not missing_labels.empty?
      puts "Updating milestone, labels on #{repo}##{issue.number}"
      github.update_issue(repo, issue.number, options)
      sleep THROTTLE_SECONDS
    end
  end
end


def make_deliverable_issue(github, repo, deliverable, workpackage, options)
  title = "#{deliverable['label']}: #{deliverable['title']}"
  issues = get_issues(github, repo)
  issue = issues.find { |i| i.title.start_with?(deliverable['label'] + ':') }
  if issue.nil?
    body = DELIV_TPL % {
      wplabel: workpackage['label'],
      wptitle: workpackage['title'],
      lead: deliverable['lead'],
      date: deliverable['due_date'],
      month: deliverable['month'],
      nature: deliverable['nature'],
      page: deliverable['page'],
    }
    puts "\n\nMaking Issue on #{repo}: #{title}"
    puts body
    github.create_issue(repo, title, body, options)
    # throttle creation calls to avoid flags for abuse
    sleep THROTTLE_SECONDS
  else
    puts "Found Issue #{repo}##{issue.number}: #{issue.title}"
    existing_labels = issue.labels.map { |label| label['name']}
    missing_labels = options[:labels].reject { |label| existing_labels.include? label }
    if issue.milestone.nil? or not missing_labels.empty?
      puts "Updating milestone, labels on #{repo}##{issue.number}"
      github.update_issue(repo, issue.number, options)
      sleep THROTTLE_SECONDS
    end
  end
end


def make_deliverable_milestone(github, repo, deliverable, workpackage)
  title = deliverable['label']
  
  milestone = get_milestones(github, repo).find { |ms| ms.title == title }
  if milestone.nil?
    puts "Making milestone on #{repo}: #{title}"
    body = DELIV_MILESTONE_TPL % {
      wplabel: workpackage['label'],
      wptitle: workpackage['title'],
      title: deliverable['title'],
      lead: deliverable['lead'],
      date: deliverable['due_date'],
      month: deliverable['month'],
      nature: deliverable['nature'],
      page: deliverable['page'],
    }
  
    milestone = github.create_milestone(repo, title,
        :due_on => deliverable['due_date'],
        :description => body,
    )
    # throttle creation calls to avoid flags for abuse
    sleep THROTTLE_SECONDS
  else
    puts "Milestone #{repo}@#{title} exists"
  end
  return milestone.number
end


def populate_workpackage(github, repo, workpackage)
  # populate issues for a given workpackage
  label = workpackage['label']

  readme_path = "#{label}/README.md"
  begin
    github.contents(repo, :path => readme_path)
  rescue Octokit::NotFound
    readme = README_TPL % {
      title: "#{workpackage['label']}: #{workpackage['title']}",
      lead: workpackage['lead'],
      page: workpackage['page'],
    }
    
    puts "Creating readme at #{repo}/#{readme_path}"
    puts readme
    github.create_contents(repo, readme_path, "Creating #{readme_path}", readme)
    # throttle creation calls to avoid flags for abuse
    sleep THROTTLE_SECONDS
  end
  
  workpackage['tasks'].each_value do |task|
    org_labels = [REVERSE_SITES[task['lead']]] + \
      (task['partners'] or []).map {|site| REVERSE_SITES[site]}
    
    make_task_issue(github, repo, task, workpackage,
      :labels => [
        'task',
        workpackage['label'],
      ] + org_labels
    )
  end
  workpackage['deliverables'].each do |deliverable|
    milestone = make_deliverable_milestone(github, repo, deliverable, workpackage)
    make_deliverable_issue(github, repo, deliverable, workpackage, {
      :milestone => milestone,
      :labels => [
        'deliverable',
        workpackage['label'],
        REVERSE_SITES[deliverable['lead']]
      ]
    })
  end
end


def main(proposal_dir)
  # run the whole thing

  # verify that there's a GitHub token in .netrc
  check_token

  # create client
  github = Octokit::Client.new(:netrc => true)
  github.auto_paginate = true

  load_pdata(proposal_dir).each do |wp|
    populate_workpackage(github, REPO, wp)
  end
end

if __FILE__ == $0
  puts ARGV
  if ARGV.length > 1
    proposal_dir = ARGV[1]
  else
    proposal_dir = '.'
  end
  main(proposal_dir)
end