-
Notifications
You must be signed in to change notification settings - Fork 582
/
gctsExecuteABAPQualityChecks.go
1989 lines (1476 loc) · 55.6 KB
/
gctsExecuteABAPQualityChecks.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
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package cmd
import (
"bytes"
"encoding/xml"
"fmt"
"html"
"net/http"
"net/http/cookiejar"
"net/url"
"os"
"regexp"
"strconv"
"strings"
"github.com/SAP/jenkins-library/pkg/command"
piperhttp "github.com/SAP/jenkins-library/pkg/http"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/pkg/errors"
)
var atcFailure, aUnitFailure bool
func gctsExecuteABAPQualityChecks(config gctsExecuteABAPQualityChecksOptions, telemetryData *telemetry.CustomData) {
// for command execution use Command
c := command.Command{}
// reroute command output to logging framework
c.Stdout(log.Writer())
c.Stderr(log.Writer())
httpClient := &piperhttp.Client{}
// error situations should stop execution through log.Entry().Fatal() call which leads to an os.Exit(1) in the end
err := rungctsExecuteABAPQualityChecks(&config, httpClient)
if err != nil {
log.Entry().WithError(err).Fatal("step execution failed")
}
if aUnitFailure || atcFailure {
log.Entry().Fatal("step execution failed")
}
}
func rungctsExecuteABAPQualityChecks(config *gctsExecuteABAPQualityChecksOptions, httpClient piperhttp.Sender) error {
const localChangedObjects = "localchangedobjects"
const remoteChangedObjects = "remotechangedobjects"
const localChangedPackages = "localchangedpackages"
const remoteChangedPackages = "remotechangedpackages"
const repository = "repository"
const packages = "packages"
cookieJar, cookieErr := cookiejar.New(nil)
if cookieErr != nil {
return errors.Wrap(cookieErr, "creating a cookie jar failed")
}
maxRetries := -1
clientOptions := piperhttp.ClientOptions{
CookieJar: cookieJar,
Username: config.Username,
Password: config.Password,
MaxRetries: maxRetries,
TransportSkipVerification: config.SkipSSLVerification,
}
httpClient.SetOptions(clientOptions)
log.Entry().Infof("start of gctsExecuteABAPQualityChecks step with configuration values: %v", config)
var objects []repoObject
var err error
log.Entry().Info("scope:", config.Scope)
switch strings.ToLower(config.Scope) {
case localChangedObjects:
objects, err = getLocalObjects(config, httpClient)
case remoteChangedObjects:
objects, err = getRemoteObjects(config, httpClient)
case localChangedPackages:
objects, err = getLocalPackages(config, httpClient)
case remoteChangedPackages:
objects, err = getRemotePackages(config, httpClient)
case repository:
objects, err = getRepositoryObjects(config, httpClient)
case packages:
objects, err = getPackages(config, httpClient)
default:
log.Entry().Info("the specified scope does not exists, the default one will be used:" + repository)
objects, err = getRepositoryObjects(config, httpClient)
}
if err != nil {
log.Entry().WithError(err).Fatal("failure in get objects")
}
if objects == nil {
log.Entry().Warning("no object delta was found, therefore the step execution will stop")
return nil
}
log.Entry().Infof("objects to be checked:")
for _, object := range objects {
log.Entry().Info(object.Type, " ", object.Object)
}
if config.AUnitTest {
// wrapper for execution of AUnit Test
err := executeAUnitTest(config, httpClient, objects)
if err != nil {
log.Entry().WithError(err)
}
if aUnitFailure {
log.Entry().Error("unit test(s) has/have failed! Check " + config.AUnitResultsFileName + " for more information! If you have enabled Warnings-Next-Generation Plugin, you can see the issues there!")
} else {
log.Entry().Info("AUnit test run completed successfully. If there are any results from the run, the results are saved in " + config.AUnitResultsFileName)
}
}
if config.AtcCheck {
// wrapper for execution of ATCChecks
err = executeATCCheck(config, httpClient, objects)
if err != nil {
log.Entry().WithError(err).Fatal("execute ATC Check failed")
}
if atcFailure {
log.Entry().Error(" ATC issue(s) found! Check " + config.AtcResultsFileName + " for more information! If you have enabled Warnings-Next-Generation Plugin, you can see the issues there!")
} else {
log.Entry().Info("ATCCheck test run completed successfully. If there are any results from the run, the results are saved in " + config.AtcResultsFileName)
}
}
return nil
}
func getLocalObjects(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) ([]repoObject, error) {
var localObjects []repoObject
var localObject repoObject
log.Entry().Info("get local changed objects started")
if config.Commit == "" {
return []repoObject{}, errors.Errorf("For scope: localChangedObjects you need to specify a commit")
}
history, err := getHistory(config, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get local changed objects failed")
}
if len(history.Result) == 0 {
return []repoObject{}, errors.Wrap(err, "no activities (from commit - to commit) were found")
}
fromCommit := history.Result[0].FromCommit
log.Entry().Info("from Commit: ", fromCommit)
toCommit := history.Result[0].ToCommit
log.Entry().Info("to Commit: ", toCommit)
// object delta between FromCommit and ToCommit retrieved from Activities Tab in gCTS
resp, err := getObjectDifference(config, fromCommit, toCommit, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get local changed objects failed")
}
for _, object := range resp.Objects {
localObject.Object = object.Name
localObject.Type = object.Type
localObjects = append(localObjects, localObject)
}
log.Entry().Info("get local changed objects finished")
return localObjects, nil
}
func getRemoteObjects(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) ([]repoObject, error) {
var remoteObjects []repoObject
var remoteObject repoObject
var currentRemoteCommit string
log.Entry().Info("get remote changed objects started")
if config.Commit == "" {
return []repoObject{}, errors.Errorf("For scope: remoteChangedObjects you need to specify a commit")
}
commitList, err := getCommitList(config, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get remote changed objects failed")
}
for i, commit := range commitList.Commits {
if commit.ID == config.Commit {
currentRemoteCommit = commitList.Commits[i+1].ID
break
}
}
if currentRemoteCommit == "" {
return []repoObject{}, errors.New("current remote commit was not found")
}
log.Entry().Info("current commit in the remote repository: ", currentRemoteCommit)
// object delta between the commit that triggered the pipeline and the current commit in the remote repository
resp, err := getObjectDifference(config, currentRemoteCommit, config.Commit, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get remote changed objects failed")
}
for _, object := range resp.Objects {
remoteObject.Object = object.Name
remoteObject.Type = object.Type
remoteObjects = append(remoteObjects, remoteObject)
}
log.Entry().Info("get remote changed objects finished")
return remoteObjects, nil
}
func getLocalPackages(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) ([]repoObject, error) {
var localPackages []repoObject
var localPackage repoObject
log.Entry().Info("get local changed packages started")
if config.Commit == "" {
return []repoObject{}, errors.Errorf("For scope: localChangedPackages you need to specify a commit")
}
history, err := getHistory(config, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get local changed objects failed")
}
if len(history.Result) == 0 {
return []repoObject{}, errors.Wrap(err, "no activities (from commit - to commit) were found")
}
fromCommit := history.Result[0].FromCommit
log.Entry().Info("from Commit: ", fromCommit)
toCommit := history.Result[0].ToCommit
log.Entry().Info("to Commit: ", toCommit)
// object delta between FromCommit and ToCommit retrieved from Activities Tab in gCTS
resp, err := getObjectDifference(config, fromCommit, config.Commit, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get local changed packages failed")
}
myPackages := map[string]bool{}
// objects are resolved into packages(DEVC)
for _, object := range resp.Objects {
objInfo, err := getObjectInfo(config, client, object.Name, object.Type)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get local changed packages failed")
}
if myPackages[objInfo.Devclass] {
} else {
myPackages[objInfo.Devclass] = true
localPackage.Object = objInfo.Devclass
localPackage.Type = "DEVC"
localPackages = append(localPackages, localPackage)
}
}
log.Entry().Info("get local changed packages finished")
return localPackages, nil
}
func getRemotePackages(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) ([]repoObject, error) {
var remotePackages []repoObject
var remotePackage repoObject
var currentRemoteCommit string
log.Entry().Info("get remote changed packages started")
if config.Commit == "" {
return []repoObject{}, errors.Errorf("For scope: remoteChangedPackages you need to specify a commit")
}
commitList, err := getCommitList(config, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get remote changed packages failed")
}
for i, commit := range commitList.Commits {
if commit.ID == config.Commit {
currentRemoteCommit = commitList.Commits[i+1].ID
break
}
}
if currentRemoteCommit == "" {
return []repoObject{}, errors.Wrap(err, "current remote commit was not found")
}
log.Entry().Info("current commit in the remote repository: ", currentRemoteCommit)
//object delta between the commit that triggered the pipeline and the current commit in the remote repository
resp, err := getObjectDifference(config, currentRemoteCommit, config.Commit, client)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get remote changed packages failed")
}
myPackages := map[string]bool{}
// objects are resolved into packages(DEVC)
for _, object := range resp.Objects {
objInfo, err := getObjectInfo(config, client, object.Name, object.Type)
if err != nil {
return []repoObject{}, errors.Wrap(err, "get remote changed packages failed")
}
if myPackages[objInfo.Devclass] {
} else {
myPackages[objInfo.Devclass] = true
remotePackage.Object = objInfo.Devclass
remotePackage.Type = "DEVC"
remotePackages = append(remotePackages, remotePackage)
}
}
log.Entry().Info("get remote changed packages finished")
return remotePackages, nil
}
func getRepositoryObjects(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) ([]repoObject, error) {
log.Entry().Info("get repository objects started")
var repoResp repoObjectResponse
url := config.Host +
"/sap/bc/cts_abapvcs/repository/" + config.Repository +
"/objects?sap-client=" + config.Client
url, urlErr := addQueryToURL(url, config.QueryParameters)
if urlErr != nil {
return nil, urlErr
}
resp, httpErr := client.SendRequest("GET", url, nil, nil, nil)
defer func() {
if resp != nil && resp.Body != nil {
resp.Body.Close()
}
}()
if httpErr != nil {
return []repoObject{}, errors.Wrap(httpErr, "could not get repository objects")
} else if resp == nil {
return []repoObject{}, errors.New("could not get repository objects: did not retrieve a HTTP response")
}
parsingErr := piperhttp.ParseHTTPResponseBodyJSON(resp, &repoResp)
if parsingErr != nil {
return []repoObject{}, errors.Errorf("%v", parsingErr)
}
var repositoryObjects []repoObject
// remove object type DEVC, because it is already included in scope packages
// also if you run ATC Checks for DEVC together with other object types, ATC checks will run only for DEVC
for _, object := range repoResp.Objects {
if object.Type != "DEVC" {
repositoryObjects = append(repositoryObjects, object)
}
}
log.Entry().Info("get repository objects finished")
// all objects that are part of the local repository
return repositoryObjects, nil
}
func getPackages(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) ([]repoObject, error) {
var packages []repoObject
log.Entry().Info("get packages started")
var repoResp repoObjectResponse
url := config.Host +
"/sap/bc/cts_abapvcs/repository/" + config.Repository +
"/objects?sap-client=" + config.Client
url, urlErr := addQueryToURL(url, config.QueryParameters)
if urlErr != nil {
return nil, urlErr
}
resp, httpErr := client.SendRequest("GET", url, nil, nil, nil)
defer func() {
if resp != nil && resp.Body != nil {
resp.Body.Close()
}
}()
if httpErr != nil {
return []repoObject{}, errors.Wrap(httpErr, "get packages failed: could not get repository objects")
} else if resp == nil {
return []repoObject{}, errors.New("get packages failed: could not get repository objects: did not retrieve a HTTP response")
}
parsingErr := piperhttp.ParseHTTPResponseBodyJSON(resp, &repoResp)
if parsingErr != nil {
return []repoObject{}, errors.Errorf("%v", parsingErr)
}
// chose only DEVC from repository objects
for _, object := range repoResp.Objects {
if object.Type == "DEVC" {
packages = append(packages, object)
}
}
log.Entry().Info("get packages finished")
return packages, nil
}
func discoverServer(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) (*http.Header, error) {
url := config.Host +
"/sap/bc/adt/core/discovery?sap-client=" + config.Client
url, urlErr := addQueryToURL(url, config.QueryParameters)
if urlErr != nil {
return nil, urlErr
}
header := make(http.Header)
header.Add("Accept", "application/atomsvc+xml")
header.Add("x-csrf-token", "fetch")
header.Add("saml2", "disabled")
disc, httpErr := client.SendRequest("GET", url, nil, header, nil)
defer func() {
if disc != nil && disc.Body != nil {
disc.Body.Close()
}
}()
if httpErr != nil {
return nil, errors.Wrap(httpErr, "discovery of the ABAP server failed")
} else if disc == nil || disc.Header == nil {
return nil, errors.New("discovery of the ABAP server failed: did not retrieve a HTTP response")
}
return &disc.Header, nil
}
func executeAUnitTest(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender, objects []repoObject) error {
log.Entry().Info("execute ABAP Unit Test started")
var innerXml string
var result runResult
for _, object := range objects {
switch object.Type {
case "CLAS":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/oo/classes/` + url.QueryEscape(object.Object) + `"/>`
case "DEVC":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/repository/informationsystem/virtualfolders?selection=package%3a` + url.QueryEscape(object.Object) + `"/>`
}
}
var xmlBody = []byte(`<?xml version="1.0" encoding="UTF-8"?>
<aunit:runConfiguration xmlns:aunit="http://www.sap.com/adt/aunit">
<external>
<coverage active="false"/>
</external>
<options>
<uriType value="semantic"/>
<testDeterminationStrategy appendAssignedTestsPreview="true" assignedTests="false" sameProgram="true"/>
<testRiskLevels critical="true" dangerous="true" harmless="true"/>
<testDurations long="true" medium="true" short="true"/>
<withNavigationUri enabled="false"/>
</options>
<adtcore:objectSets xmlns:adtcore="http://www.sap.com/adt/core">
<objectSet kind="inclusive">
<adtcore:objectReferences>` +
innerXml +
`</adtcore:objectReferences>
</objectSet>
</adtcore:objectSets>
</aunit:runConfiguration>`)
resp, err := runAUnitTest(config, client, xmlBody)
if err != nil {
return errors.Wrap(err, "execute of Aunit test has failed")
}
parsingErr := piperhttp.ParseHTTPResponseBodyXML(resp, &result)
if parsingErr != nil {
log.Entry().Warning(parsingErr)
return nil
}
parsedRes, err := parseUnitResult(config, client, &result)
if err != nil {
log.Entry().Warning(err)
return nil
}
log.Entry().Info("execute ABAP Unit Test finished.", parsedRes.Text)
return nil
}
func runAUnitTest(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender, xml []byte) (response *http.Response, err error) {
log.Entry().Info("run ABAP Unit Test started")
url := config.Host +
"/sap/bc/adt/abapunit/testruns?sap-client=" + config.Client
url, urlErr := addQueryToURL(url, config.QueryParameters)
if urlErr != nil {
return nil, urlErr
}
discHeader, discError := discoverServer(config, client)
if discError != nil {
return response, errors.Wrap(discError, "run of unit tests failed")
}
if discHeader.Get("X-Csrf-Token") == "" {
return response, errors.Errorf("could not retrieve x-csrf-token from server")
}
header := make(http.Header)
header.Add("x-csrf-token", discHeader.Get("X-Csrf-Token"))
header.Add("Accept", "application/xml")
header.Add("Content-Type", "application/vnd.sap.adt.abapunit.testruns.result.v1+xml")
response, httpErr := client.SendRequest("POST", url, bytes.NewBuffer(xml), header, nil)
if httpErr != nil {
return response, errors.Wrap(httpErr, "run of unit tests failed")
} else if response == nil {
return response, errors.New("run of unit tests failed: did not retrieve a HTTP response")
}
log.Entry().Info("run ABAP Unit Test finished")
return response, nil
}
func parseUnitResult(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender, aUnitRunResult *runResult) (parsedResult checkstyle, err error) {
log.Entry().Info("parse ABAP Unit Result started")
var fileName string
var aUnitFile file
var aUnitError checkstyleError
parsedResult.Version = "1.0"
for _, program := range aUnitRunResult.Program {
objectType := program.Type[0:4]
objectName := program.Name
//syntax error in unit test or class
if program.Alerts.Alert.HasSyntaxErrors == "true" {
aUnitFailure = true
aUnitError.Source = objectName
aUnitError.Severity = "error"
log.Entry().Info("severity: ", aUnitError.Severity)
aUnitError.Message = html.UnescapeString(program.Alerts.Alert.Title + " " + program.Alerts.Alert.Details.Detail.AttrText)
log.Entry().Info("message: ", aUnitError.Message)
aUnitError.Line, err = findLine(config, client, program.Alerts.Alert.Stack.StackEntry.URI, objectName, objectType)
log.Entry().Error("line: ", aUnitError.Line)
if err != nil {
return parsedResult, errors.Wrap(err, "parse AUnit Result failed")
}
fileName, err = getFileName(config, client, program.Alerts.Alert.Stack.StackEntry.URI, objectName)
log.Entry().Error("file path: ", aUnitError.Line)
if err != nil {
return parsedResult, errors.Wrap(err, "parse AUnit Result failed")
}
aUnitFile.Error = append(aUnitFile.Error, aUnitError)
aUnitError = checkstyleError{}
log.Entry().Error("there is a syntax error", aUnitFile)
}
for _, testClass := range program.TestClasses.TestClass {
for _, testMethod := range testClass.TestMethods.TestMethod {
aUnitError.Source = testClass.Name + "/" + testMethod.Name
// unit test failure
if len(testMethod.Alerts.Alert) > 0 {
for _, testalert := range testMethod.Alerts.Alert {
switch testalert.Severity {
case "fatal":
log.Entry().Error("unit test " + aUnitError.Source + " has failed with severity fatal")
aUnitFailure = true
aUnitError.Severity = "error"
case "critical":
log.Entry().Error("unit test " + aUnitError.Source + " has failed with severity critical")
aUnitFailure = true
aUnitError.Severity = "error"
case "tolerable":
log.Entry().Warning("unit test " + aUnitError.Source + " has failed with severity warning")
aUnitError.Severity = "warning"
default:
aUnitError.Severity = "info"
}
//unit test message is spread in different elements
for _, detail := range testalert.Details.Detail {
aUnitError.Message = aUnitError.Message + " " + detail.AttrText
for _, subdetail := range detail.Details.Detail {
aUnitError.Message = html.UnescapeString(aUnitError.Message + " " + subdetail.AttrText)
log.Entry().Info("message: ", aUnitError.Message)
}
}
aUnitError.Line, err = findLine(config, client, testalert.Stack.StackEntry.URI, objectName, objectType)
log.Entry().Info("line: ", aUnitError.Line)
if err != nil {
log.Entry().Warning(err)
}
}
aUnitFile.Error = append(aUnitFile.Error, aUnitError)
aUnitError = checkstyleError{}
} else {
log.Entry().Info("unit test:", aUnitError.Source, "- was successful")
}
}
fileName, err = getFileName(config, client, testClass.URI, objectName)
if err != nil {
return parsedResult, errors.Wrap(err, "parse AUnit Result failed")
}
}
aUnitFile.Name, err = constructPath(config, client, fileName, objectName, objectType)
log.Entry().Error("file path: ", aUnitFile.Name)
if err != nil {
return parsedResult, errors.Wrap(err, "parse AUnit Result failed")
}
parsedResult.File = append(parsedResult.File, aUnitFile)
aUnitFile = file{}
}
body, _ := xml.Marshal(parsedResult)
writeErr := os.WriteFile(config.AUnitResultsFileName, body, 0644)
if writeErr != nil {
log.Entry().Error("file AUnitResults.xml could not be created")
return parsedResult, fmt.Errorf("handling unit test results failed: %w", writeErr)
}
log.Entry().Info("parse ABAP Unit Result finished")
return parsedResult, nil
}
func executeATCCheck(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender, objects []repoObject) (error error) {
log.Entry().Info("execute ATC Check started")
var innerXml string
var result worklist
for _, object := range objects {
switch object.Type {
case "CLAS":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/oo/classes/` + url.QueryEscape(object.Object) + `"/>`
case "INTF":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/oo/interfaces/` + object.Object + `"/>`
case "DEVC":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/repository/informationsystem/virtualfolders?selection=package%3a` + url.QueryEscape(object.Object) + `"/>`
case "FUGR":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/functions/groups/` + object.Object + `/source/main"/>`
case "TABL":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/ddic/tables/` + object.Object + `/source/main"/>`
case "DTEL":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/ddic/dataelements/` + object.Object + `"/>`
case "DOMA":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/ddic/domains/` + object.Object + `"/>`
case "MSAG":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/messageclass/` + object.Object + `"/>`
case "PROG":
innerXml = innerXml + `<adtcore:objectReference adtcore:uri="/sap/bc/adt/programs/programs/` + object.Object + `/source/main"/>`
default:
log.Entry().Warning("object Type " + object.Type + " is not supported!")
}
}
var xmlBody = []byte(`<?xml version="1.0" encoding="UTF-8"?>
<atc:run xmlns:atc="http://www.sap.com/adt/atc"
maximumVerdicts="100">
<objectSets xmlns:adtcore="http://www.sap.com/adt/core">
<objectSet kind="inclusive">
<adtcore:objectReferences>` + innerXml +
`</adtcore:objectReferences>
</objectSet>
</objectSets>
</atc:run>`)
worklist, err := getWorklist(config, client)
if err != nil {
return errors.Wrap(err, "execution of ATC Checks failed")
}
err = startATCRun(config, client, xmlBody, worklist)
if err != nil {
return errors.Wrap(err, "execution of ATC Checks failed")
}
resp, err := getATCRun(config, client, worklist)
if err != nil {
return errors.Wrap(err, "execution of ATC Checks failed")
}
parsingErr := piperhttp.ParseHTTPResponseBodyXML(resp, &result)
if parsingErr != nil {
log.Entry().Warning(parsingErr)
return nil
}
atcRes, err := parseATCCheckResult(config, client, &result)
if err != nil {
log.Entry().Error(err)
return errors.Wrap(err, "execution of ATC Checks failed")
}
log.Entry().Info("execute ATC Checks finished.", atcRes.Text)
return nil
}
func startATCRun(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender, xml []byte, worklistID string) (err error) {
log.Entry().Info("ATC Run started")
discHeader, discError := discoverServer(config, client)
if discError != nil {
return errors.Wrap(discError, "start of ATC run failed")
}
if discHeader.Get("X-Csrf-Token") == "" {
return errors.Errorf("could not retrieve x-csrf-token from server")
}
header := make(http.Header)
header.Add("x-csrf-token", discHeader.Get("X-Csrf-Token"))
header.Add("Accept", "application/xml")
url := config.Host +
"/sap/bc/adt/atc/runs?worklistId=" + worklistID + "&sap-client=" + config.Client
url, urlErr := addQueryToURL(url, config.QueryParameters)
if urlErr != nil {
return urlErr
}
resp, httpErr := client.SendRequest("POST", url, bytes.NewBuffer(xml), header, nil)
defer func() {
if resp != nil && resp.Body != nil {
resp.Body.Close()
}
}()
if httpErr != nil {
return errors.Wrap(httpErr, "start of ATC run failed")
} else if resp == nil {
return errors.New("start of ATC run failed: did not retrieve a HTTP response")
}
log.Entry().Info("ATC Run finished")
return nil
}
func getATCRun(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender, worklistID string) (response *http.Response, err error) {
log.Entry().Info("get ATC Run Results started")
header := make(http.Header)
url := config.Host +
"/sap/bc/adt/atc/worklists/" + worklistID + "?sap-client=" + config.Client
url, urlErr := addQueryToURL(url, config.QueryParameters)
if urlErr != nil {
return nil, urlErr
}
header.Add("Accept", "application/atc.worklist.v1+xml")
resp, httpErr := client.SendRequest("GET", url, nil, header, nil)
if httpErr != nil {
return response, errors.Wrap(httpErr, "get ATC run failed")
} else if resp == nil {
return response, errors.New("get ATC run failed: did not retrieve a HTTP response")
}
log.Entry().Info("get ATC Run Results finished")
return resp, nil
}
func getWorklist(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender) (worklistID string, error error) {
url := config.Host +
"/sap/bc/adt/atc/worklists?checkVariant=" + config.AtcVariant + "&sap-client=" + config.Client
discHeader, discError := discoverServer(config, client)
url, urlErr := addQueryToURL(url, config.QueryParameters)
if urlErr != nil {
return worklistID, urlErr
}
if discError != nil {
return worklistID, errors.Wrap(discError, "get worklist failed")
}
if discHeader.Get("X-Csrf-Token") == "" {
return worklistID, errors.Errorf("could not retrieve x-csrf-token from server")
}
header := make(http.Header)
header.Add("x-csrf-token", discHeader.Get("X-Csrf-Token"))
header.Add("Accept", "*/*")
resp, httpErr := client.SendRequest("POST", url, nil, header, nil)
defer func() {
if resp != nil && resp.Body != nil {
resp.Body.Close()
}
}()
if httpErr != nil {
return worklistID, errors.Wrap(httpErr, "get worklist failed")
} else if resp == nil {
return worklistID, errors.New("get worklist failed: did not retrieve a HTTP response")
}
location := resp.Header["Location"][0]
locationSlice := strings.Split(location, "/")
worklistID = locationSlice[len(locationSlice)-1]
log.Entry().Info("worklist id for ATC check: ", worklistID)
return worklistID, nil
}
func parseATCCheckResult(config *gctsExecuteABAPQualityChecksOptions, client piperhttp.Sender, response *worklist) (atcResults checkstyle, error error) {
log.Entry().Info("parse ATC Check Result started")
var atcFile file
var subObject string
var aTCUnitError checkstyleError
atcResults.Version = "1.0"
for _, object := range response.Objects.Object {
objectType := object.Type
objectName := object.Name
for _, atcworklist := range object.Findings.Finding {
log.Entry().Info("there is atc finding for object type: ", objectType+" object name: "+objectName)
path, err := url.PathUnescape(atcworklist.Location)
if err != nil {
return atcResults, errors.Wrap(err, "conversion of ATC check results to CheckStyle has failed")
}
if len(atcworklist.Atcfinding) > 0 {
priority, err := strconv.Atoi(atcworklist.Priority)
if err != nil {
return atcResults, errors.Wrap(err, "conversion of ATC check results to CheckStyle has failed")
}
switch priority {
case 1:
atcFailure = true
aTCUnitError.Severity = "error"
log.Entry().Error("atc issue with priority: 1 ")
case 2:
atcFailure = true
aTCUnitError.Severity = "error"
log.Entry().Error("atc issue with priority: 2 ")
case 3:
aTCUnitError.Severity = "warning"
log.Entry().Warning("atc issue with priority: 3 ")
default:
aTCUnitError.Severity = "info"