/
placementreport.go
330 lines (299 loc) · 10.2 KB
/
placementreport.go
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
/*
Copyright 2019 The Pennsylvania State University
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package aleks
import (
"encoding/csv"
"errors"
"fmt"
"io"
"regexp"
"strconv"
"strings"
"time"
"github.com/kelseyhightower/envconfig"
"github.com/kolo/xmlrpc"
log "github.com/sirupsen/logrus"
)
const (
placementReportMethod = "getPlacementReport"
placementReportRequestDateFormat = "2006-01-02"
placementReportRequestClasscodeFormat = "[A-Z]{5}-[A-Z]{5}"
placementReportHeaderColumn00 = "Name"
placementReportHeaderColumn01 = "Student Id"
placementReportHeaderColumn02 = "Email"
placementReportHeaderColumn03 = "Last login"
placementReportHeaderColumn04 = "Placement Assessment Number"
placementReportHeaderColumn05 = "Total Number of Placements Taken"
placementReportHeaderColumn06 = "Start Date"
placementReportHeaderColumn07 = "Start Time"
placementReportHeaderColumn08 = "End Date"
placementReportHeaderColumn09 = "End Time"
placementReportHeaderColumn10 = "Proctored Assessment"
placementReportHeaderColumn11 = "Time in Placement (in hours)"
placementReportHeaderColumn12 = "Placement Results %"
placementReportEndMarker = "No records found"
placementRecordFieldCount = 13
placementRecordDateFormat = "01/02/2006"
placementRecordTimestampFormat = "01/02/2006 03:04 PM"
)
const (
classcodeValidationErrorMessage = "Class code does not match required format: "
)
// PlacementReport contains the PlacementRecords returned (if any) by the
// GetPlacementReport and GetPlacementReportFromEnv methods.
type PlacementReport []PlacementRecord
// GetPlacementReport calls the Aleks XML-RPC method of the same name for
// one or more class-codes and returns the results as a list of
// PlacementRecords. A collection of errors that occurred during this
// process is also collected and returned to the caller. Note that it is
// possible for both PlacementRecords and errors to be returned from the
// same call as valid PlacementRecords are not discarded due to errors
// in other records.
//
// This method uses an individual thread to retrieve the data for each
// class-code and collects the results in a single PlacementReport to
// reduce the time it takes to retrieve large data sets. Requesting
// large numbers of class-codes will therefore result in a large number
// of threads.
func (c *Client) GetPlacementReport(from, to string, classcodes ...string) (PlacementReport, []error) {
pr := PlacementReport{}
errs := []error{}
errs = append(errs, validateRequestDate(from)...)
errs = append(errs, validateRequestDate(to)...)
errs = append(errs, validateClasscodes(classcodes)...)
if len(errs) > 0 {
return pr, errs
}
type result struct {
PlacementReport PlacementReport
Errors []error
}
r := make(chan result, len(classcodes))
// Scatter
for _, code := range classcodes {
xc, err := xmlrpc.NewClient(c.url, c.trans)
if err != nil {
errs = append(errs, err)
continue
}
params := map[string]string{
"username": c.username,
"password": c.password,
"from_completion_date": from,
"to_completion_date": to,
"class_code": code,
}
go func() {
pr, err := getPlacementReportForClasscode(xc, params)
r <- result{pr, err}
}()
}
// Gather
for i := 0; i < cap(r); i++ {
res := <-r
errs = append(errs, res.Errors...)
pr = append(pr, res.PlacementReport...)
}
return pr, errs
}
type placementReportEnvConfig struct {
From string `envconfig:"FROM_COMPLETION_DATE" required:"true"`
To string `envconfig:"TO_COMPLETION_DATE" required:"true"`
Classcodes []string `required:"true"`
}
// GetPlacementReportFromEnv returns PlacementRecords and errors as
// described by the documentation for GetPlacementReport but retrieves
// its configuration from environment variables as follows:
//
// - ALEKS_FROM_COMPLETION_DATE (Required - YYYY-MM-DD)
// - ALEKS_TO_COMPLETION_DATE (Required - YYYY-MM-DD)
// - ALEKS_CLASSCODES (Required - One or more class-codes
// with the format AAAAA-AAAAA in a comma
// separated string)
func (c *Client) GetPlacementReportFromEnv() (PlacementReport, []error) {
cfg := placementReportEnvConfig{}
err := envconfig.Process(AleksEnvconfigPrefix, &cfg)
if err != nil {
return nil, []error{err}
}
return c.GetPlacementReport(cfg.From, cfg.To, cfg.Classcodes...)
}
func getPlacementReportForClasscode(xc *xmlrpc.Client, params map[string]string) (PlacementReport, []error) {
rep := PlacementReport{}
errs := []error{}
for page := 1; true; page++ {
params["page_num"] = strconv.FormatInt(int64(page), 10)
data := ""
err := xc.Call(placementReportMethod, params, &data)
if err != nil {
return nil, append(errs, err)
}
data = strings.Trim(data, " \n")
if data == placementReportEndMarker {
break
}
log.Debug("Page data: ", data)
r, e := getPlacementRecordsForPage(data)
rep = append(rep, r...)
errs = append(errs, e...)
}
return rep, errs
}
func getPlacementRecordsForPage(data string) (PlacementReport, []error) {
rdr := csv.NewReader(strings.NewReader(data))
rdr.FieldsPerRecord = placementRecordFieldCount
rdr.ReuseRecord = true
rep := PlacementReport{}
errs := []error{}
for first := true; true; first = false {
rec, err := rdr.Read()
if err == io.EOF {
break
}
if err != nil {
errs = append(errs, err)
continue
}
if first {
errs = append(errs, validateHeaders(rec)...)
continue
}
r, e := newPlacementRecord(rec)
log.Debug("Placement record: ", r)
errs = append(errs, e...)
rep = append(rep, r)
}
return rep, errs
}
func validateClasscodes(classcodes []string) []error {
errs := []error{}
re, err := regexp.Compile(placementReportRequestClasscodeFormat)
if err != nil {
errs = append(errs, err)
}
for _, classcode := range classcodes {
if !re.Match([]byte(classcode)) {
errs = append(errs, errors.New(classcodeValidationErrorMessage+classcode))
}
}
return errs
}
func validateHeaders(record []string) []error {
errs := []error{}
for idx, hdr := range record {
exp := expectedHeaders()[idx]
if hdr != exp {
msg := fmt.Sprintf("Unexpected header column title (%d) - expected: %s, actual: %s", idx, hdr, exp)
errs = append(errs, errors.New(msg))
}
}
return errs
}
func validateRequestDate(value string) []error {
errs := []error{}
_, err := time.Parse(placementReportRequestDateFormat, value)
if err != nil {
errs = append(errs, err)
}
return errs
}
func expectedHeaders() []string {
return []string{
placementReportHeaderColumn00,
placementReportHeaderColumn01,
placementReportHeaderColumn02,
placementReportHeaderColumn03,
placementReportHeaderColumn04,
placementReportHeaderColumn05,
placementReportHeaderColumn06,
placementReportHeaderColumn07,
placementReportHeaderColumn08,
placementReportHeaderColumn09,
placementReportHeaderColumn10,
placementReportHeaderColumn11,
placementReportHeaderColumn12,
}
}
// PlacementRecord provides the results of an individual placement exam.
// The Aleks format returns 13 strings formatted as a CSV record. The
// 11 fields below are in the same order and (almost) have the same names
// as the columns in this CSV report - the "Start Date"/"Start Time" and
// "End Date"/"End Time" columns are combined into a single field below.
// In addition, all string columns are validated and converted to their
// appropriate types.
type PlacementRecord struct {
Name string
StudentID string
Email string
LastLogin time.Time
PlacementAssessmentNumber int
TotalNumberOfPlacementsTaken int
StartTime time.Time
EndTime time.Time
ProctoredAssessment string
HoursInPlacement float64
PlacementResults float64
}
func newPlacementRecord(rec []string) (PlacementRecord, []error) {
log.Debug(" CSV record: ", rec)
errs := []error{}
lastLogin, errs := parseDate(rec[3], errs)
placementAssessmentNumber, errs := parseInt(rec[4], errs)
totalNumberOfPlacementsTaken, errs := parseInt(rec[5], errs)
startTime, errs := parseTime(rec[6]+" "+rec[7], errs)
endTime, errs := parseTime(rec[8]+" "+rec[9], errs)
hoursInPlacement, errs := parseFloat(rec[11], errs)
placementResults, errs := parseFloat(rec[12], errs)
return PlacementRecord{
Name: rec[0],
StudentID: rec[1],
Email: rec[2],
LastLogin: lastLogin,
PlacementAssessmentNumber: placementAssessmentNumber,
TotalNumberOfPlacementsTaken: totalNumberOfPlacementsTaken,
StartTime: startTime,
EndTime: endTime,
ProctoredAssessment: rec[10],
HoursInPlacement: hoursInPlacement,
PlacementResults: placementResults,
}, errs
}
func parseDate(value string, errs []error) (time.Time, []error) {
d, err := time.Parse(placementRecordDateFormat, value)
if err != nil {
errs = append(errs, err)
}
return d, errs
}
func parseInt(value string, errs []error) (int, []error) {
i, err := strconv.ParseInt(value, 10, 64)
if err != nil {
errs = append(errs, err)
}
return int(i), errs
}
func parseFloat(value string, errs []error) (float64, []error) {
value = strings.ReplaceAll(value, "%", "")
f, err := strconv.ParseFloat(value, 64)
if err != nil {
errs = append(errs, err)
}
return f, errs
}
func parseTime(value string, errs []error) (time.Time, []error) {
t, err := time.Parse(placementRecordTimestampFormat, value)
if err != nil {
errs = append(errs, err)
}
return t, errs
}