-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(test): report api output and service logs on failure (#697)
* feat(test): report api output in case of failure * feat(test): report service logs in case of failure * feat(test): add report failed method and add method descriptions * feat(test): configure failure reports per test * feat(test): create new test report file * feat(test): simplify failure report configuration * feat(test): use indent in api data dump * feat(test): use since timestamp instead of tail in service logs
- Loading branch information
Showing
7 changed files
with
254 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| // Copyright © 2023 Cisco Systems, Inc. and its affiliates. | ||
| // All rights reserved. | ||
| // | ||
| // 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 e2e | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "time" | ||
|
|
||
| "github.com/onsi/ginkgo/v2" | ||
| "github.com/onsi/ginkgo/v2/formatter" | ||
| "github.com/onsi/gomega" | ||
|
|
||
| "github.com/openclarity/vmclarity/api/models" | ||
| "github.com/openclarity/vmclarity/e2e/testenv" | ||
| "github.com/openclarity/vmclarity/pkg/shared/backendclient" | ||
| "github.com/openclarity/vmclarity/pkg/shared/utils" | ||
| ) | ||
|
|
||
| type APIObject struct { | ||
| objectType string | ||
| filter string | ||
| } | ||
|
|
||
| type ReportFailedConfig struct { | ||
| startTime time.Time | ||
| // if not empty, print logs for services in slice. if empty, print logs for all services. | ||
| services []string | ||
| // if true, print all API objects. | ||
| allAPIObjects bool | ||
| // if not empty, print objects in slice. | ||
| objects []APIObject | ||
| } | ||
|
|
||
| // ReportFailed gathers relevant API data and docker service logs for debugging purposes. | ||
| func ReportFailed(ctx ginkgo.SpecContext, testEnv *testenv.Environment, client *backendclient.BackendClient, config *ReportFailedConfig) { | ||
| ginkgo.GinkgoWriter.Println("------------------------------") | ||
|
|
||
| DumpAPIData(ctx, client, config) | ||
| DumpServiceLogs(ctx, testEnv, config) | ||
|
|
||
| ginkgo.GinkgoWriter.Println("------------------------------") | ||
| } | ||
|
|
||
| // nolint:cyclop | ||
| // DumpAPIData prints API objects filtered using test parameters (e.g. assets filtered by scope, scan configs filtered by id). | ||
| // If filter not provided, no objects are printed. | ||
| func DumpAPIData(ctx ginkgo.SpecContext, client *backendclient.BackendClient, config *ReportFailedConfig) { | ||
| ginkgo.GinkgoWriter.Println(formatter.F("{{red}}[FAILED] Report API Data:{{/}}")) | ||
|
|
||
| if config.allAPIObjects { | ||
| config.objects = append(config.objects, APIObject{"asset", ""}, APIObject{"scanConfigs", ""}, APIObject{"scans", ""}) | ||
| } | ||
|
|
||
| for _, object := range config.objects { | ||
| switch object.objectType { | ||
| case "asset": | ||
| var params models.GetAssetsParams | ||
| if object.filter == "" { | ||
| params = models.GetAssetsParams{} | ||
| } else { | ||
| params = models.GetAssetsParams{Filter: utils.PointerTo(object.filter)} | ||
| } | ||
| assets, err := client.GetAssets(ctx, params) | ||
| gomega.Expect(err).NotTo(gomega.HaveOccurred()) | ||
|
|
||
| buf, err := json.MarshalIndent(*assets.Items, "", "\t") | ||
| gomega.Expect(err).NotTo(gomega.HaveOccurred()) | ||
| ginkgo.GinkgoWriter.Printf("Asset: %s\n", string(buf)) | ||
|
|
||
| case "scanConfig": | ||
| var params models.GetScanConfigsParams | ||
| if object.filter == "" { | ||
| params = models.GetScanConfigsParams{} | ||
| } else { | ||
| params = models.GetScanConfigsParams{Filter: utils.PointerTo(object.filter)} | ||
| } | ||
| scanConfigs, err := client.GetScanConfigs(ctx, params) | ||
| gomega.Expect(err).NotTo(gomega.HaveOccurred()) | ||
|
|
||
| buf, err := json.MarshalIndent(*scanConfigs.Items, "", "\t") | ||
| gomega.Expect(err).NotTo(gomega.HaveOccurred()) | ||
| ginkgo.GinkgoWriter.Printf("Scan Config: %s\n", string(buf)) | ||
|
|
||
| case "scan": | ||
| var params models.GetScansParams | ||
| if object.filter == "" { | ||
| params = models.GetScansParams{} | ||
| } else { | ||
| params = models.GetScansParams{Filter: utils.PointerTo(object.filter)} | ||
| } | ||
| scans, err := client.GetScans(ctx, params) | ||
| gomega.Expect(err).NotTo(gomega.HaveOccurred()) | ||
|
|
||
| buf, err := json.MarshalIndent(*scans.Items, "", "\t") | ||
| gomega.Expect(err).NotTo(gomega.HaveOccurred()) | ||
| ginkgo.GinkgoWriter.Printf("Scan: %s\n", string(buf)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // DumpServiceLogs prints service logs since the test started until it failed. | ||
| func DumpServiceLogs(ctx ginkgo.SpecContext, testEnv *testenv.Environment, config *ReportFailedConfig) { | ||
| ginkgo.GinkgoWriter.Println(formatter.F("{{red}}[FAILED] Report Service Logs:{{/}}")) | ||
|
|
||
| if len(config.services) == 0 { | ||
| config.services = testEnv.Services() | ||
| } | ||
|
|
||
| err := testEnv.ServiceLogs(ctx, config.services, config.startTime, formatter.ColorableStdOut, formatter.ColorableStdErr) | ||
| gomega.Expect(err).NotTo(gomega.HaveOccurred()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters