Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌱 add csv import test #390

Merged
merged 22 commits into from
Jul 3, 2023
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions binding/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
pathlib "path"
"path/filepath"
"strings"
"time"
"time"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit, but not needed change, please remove trailing spaces.

)

const (
Expand Down Expand Up @@ -192,7 +192,6 @@ func (r *Client) Post(path string, object interface{}) (err error) {
default:
err = liberr.New(http.StatusText(status))
}

return
}

Expand Down Expand Up @@ -447,6 +446,29 @@ func (r *Client) FilePut(path, source string, object interface{}) (err error) {
return
}

//
// FilePost uploads a file.
// Returns the created File resource.
func (r *Client) FilePost(path, source string, object interface{}) (err error) {
isDir, nErr := r.IsDir(source, true)
if nErr != nil {
err = nErr
return
}
if isDir {
err = liberr.New("Must be regular file.")
return
}
fields := []Field{
{
Name: api.FileField,
Path: source,
},
}
err = r.FileSend(path, http.MethodPost, fields, object)
return
}

//
// FileSend sends file upload from.
func (r *Client) FileSend(path, method string, fields []Field, object interface{}) (err error) {
Expand Down
2 changes: 1 addition & 1 deletion docs/test-api-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ application|:white_check_mark: partially|:heavy_check_mark:||
bucket||||partially within application
dependency|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|
file|:heavy_check_mark:|:heavy_check_mark:||
import||||
import||:heavy_check_mark:|:heavy_check_mark:|
khareyash05 marked this conversation as resolved.
Show resolved Hide resolved
review||||
**Controls**||||
businessservice|:heavy_check_mark:|:heavy_check_mark:||
Expand Down
171 changes: 171 additions & 0 deletions test/api/importcsv/api_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
package importcsv

import (
"io/ioutil"
"os"
"testing"
"time"
"github.com/konveyor/tackle2-hub/api"
"github.com/konveyor/tackle2-hub/binding"
"github.com/konveyor/tackle2-hub/test/assert"
)

func TestImportCSV(t *testing.T) {
for _, r := range TestCases {
t.Run(r.FileName, func(t *testing.T) {

// Upload CSV.
inputData := api.ImportSummary{}
assert.Must(t, Client.FilePost(api.UploadRoot, r.FileName, &inputData))

// Inject import summary id into Summary root
pathForImportSummary := binding.Path(api.SummaryRoot).Inject(binding.Params{api.ID: inputData.ID})

// Since uploading the CSV happens asynchronously we need to wait for the upload to check Applications and Dependencies.
time.Sleep(time.Second)

var outputImportSummaries []api.ImportSummary
outputMatchingSummary := api.ImportSummary{}
for{
assert.Should(t, Client.Get(api.SummariesRoot, &outputImportSummaries))
for _, gotImport := range outputImportSummaries {
if uint(gotImport.ID) == inputData.ID {
outputMatchingSummary = gotImport
}
}
if(outputMatchingSummary.ValidCount + outputMatchingSummary.InvalidCount == len(r.ExpectedApplications)+len(r.ExpectedDependencies)){
break
}
time.Sleep(time.Second)
}

// Check list of Applications.
gotApps, _ := Application.List()
if len(gotApps) != len(r.ExpectedApplications) {
t.Errorf("Mismatch in number of imported Applications: Expected %d, Actual %d", len(r.ExpectedApplications), len(gotApps))
} else {
for i, importedApp := range gotApps {
khareyash05 marked this conversation as resolved.
Show resolved Hide resolved
if r.ExpectedApplications[i].Name != importedApp.Name {
t.Errorf("Mismatch in name of imported Application: Expected %s, Actual %s", r.ExpectedApplications[i].Name, importedApp.Name)
}
if r.ExpectedApplications[i].Description != importedApp.Description {
t.Errorf("Mismatch in description of imported Application: Expected %s, Actual %s", r.ExpectedApplications[i].Description, importedApp.Description)
}
if r.ExpectedApplications[i].Repository.Kind != importedApp.Repository.Kind {
t.Errorf("Mismatch in repository's kind ofimported Application: Expected %s, Actual %s", r.ExpectedApplications[i].Repository.Kind, importedApp.Repository.Kind)
}
if r.ExpectedApplications[i].Repository.URL != importedApp.Repository.URL {
t.Errorf("Mismatch in repository's url of imported Application: Expected %s, Actual %s", r.ExpectedApplications[i].Repository.URL, importedApp.Repository.URL)
}
if r.ExpectedApplications[i].Binary != importedApp.Binary {
t.Errorf("Mismatch in binary of imported Application: Expected %s, Actual %s", r.ExpectedApplications[i].Binary, importedApp.Binary)
}
for j, tag := range r.ExpectedApplications[i].Tags {
if tag.Name != importedApp.Tags[j].Name {
t.Errorf("Mismatch in tag name of imported Application: Expected %s, Actual %s", tag.Name, importedApp.Tags[j].Name)
}
}
if r.ExpectedApplications[i].BusinessService.Name != importedApp.BusinessService.Name {
t.Errorf("Mismatch in name of the BusinessService of imported Application: Expected %s, Actual %s", r.ExpectedApplications[i].BusinessService.Name, importedApp.BusinessService.Name)
}
}
}

// Check list of Dependencies.
gotDeps, _ := Dependency.List()
if len(gotDeps) != len(r.ExpectedDependencies) {
t.Errorf("Mismatch in number of imported Dependencies: Expected %d, Actual %d", len(r.ExpectedDependencies), len(gotDeps))
} else {
for i, importedDep := range gotDeps {
if importedDep.To.Name != r.ExpectedDependencies[i].To.Name {
t.Errorf("Mismatch in imported Dependency: Expected %s, Actual %s", r.ExpectedDependencies[i].To.Name, importedDep.To.Name)
}
if importedDep.From.Name != r.ExpectedDependencies[i].From.Name {
t.Errorf("Mismatch in imported Dependency: Expected %s, Actual %s", r.ExpectedDependencies[i].From.Name, importedDep.From.Name)
}
}
}

// Get summaries of the Input ID.
outputImportSummary := api.ImportSummary{}
assert.Should(t, Client.Get(pathForImportSummary, &outputImportSummary))

// Get all imports.
aufi marked this conversation as resolved.
Show resolved Hide resolved
var outputImports []api.Import
assert.Should(t, Client.Get(api.ImportsRoot, &outputImports))

// Check for number of imports.
if len(outputImports) != len(r.ExpectedApplications)+len(r.ExpectedDependencies) {
t.Errorf("Mismatch in number of imports")
}

// Checks for individual applications and dependencies.
j, k := 0, 0
for _, imp := range outputImports {
if imp["recordType1"] == 1 && j < len(r.ExpectedApplications) {
// An Application with no dependencies.
if r.ExpectedApplications[j].Name != imp["applicationName"] {
t.Errorf("Mismatch in name of import: Expected %s, Actual %s", r.ExpectedApplications[j].Name, imp["applicationName"])
}
if r.ExpectedApplications[j].Description != imp["description"] {
t.Errorf("Mismatch in name of import: Expected %s, Actual %s", r.ExpectedApplications[j].Description, imp["description"])
}
if r.ExpectedApplications[j].BusinessService.Name != imp["businessService"] {
t.Errorf("Mismatch in name of import: Expected %s, Actual %s", r.ExpectedApplications[j].BusinessService.Name, imp["businessService"])
}
j++
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC, shouldn't there be a second part of the condition - if outputImports has more records than expectedApps, the test should fail too. Same for dependencies few lines below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

outputimports consist of both applications and dependencies thus shouldn't be equal to length of sums?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the CSV for this test would get one more line with an application, but the test (expected applications) was not changed (=> more imports type 1, but not changed len(expectedApps)), it looks to me to pass this part of the test anywa - that was the thing I didn't like. On the other hand there is a check of gotApps len() on line 44 and in this PR we don't have to do deeper rejection tests, so it is likely OK.

if imp["recordType1"] == 2 && k < len(r.ExpectedDependencies) {
// An Application with Dependencies.
if r.ExpectedDependencies[k].From.Name != imp["applicationName"] {
t.Errorf("Mismatch in name of import: Expected %s, Actual %s", r.ExpectedDependencies[k].From.Name, imp["applicationName"])
}
if r.ExpectedDependencies[k].To.Name != imp["dependency"] {
t.Errorf("Mismatch in name of import: Expected %s, Actual %s", r.ExpectedDependencies[k].To.Name, imp["dependency"])
}
k++
}
}

// Download the csv.
khareyash05 marked this conversation as resolved.
Show resolved Hide resolved
pathToGotCSV := "downloadcsv.csv"
assert.Should(t, Client.FileGet(api.DownloadRoot, pathToGotCSV))

// Read the got CSV file.
gotCSV, err := ioutil.ReadFile(pathToGotCSV)
if err != nil {
t.Errorf("Error reading CSV: %s", pathToGotCSV)
}
gotCSVString := string(gotCSV)

// Read the expected CSV file.
expectedCSV, err := ioutil.ReadFile(r.FileName)
if err != nil {
t.Errorf("Error reading CSV: %s", r.FileName)
}
expectedCSVString := string(expectedCSV)
if gotCSVString != expectedCSVString {
t.Errorf("The CSV files have different content %s and %s", gotCSVString, expectedCSVString)
}

// Remove the CSV file created.
err = os.Remove(pathToGotCSV)
if err != nil {
t.Errorf(err.Error())
}

// Delete imported summaries
assert.Must(t, Client.Delete(pathForImportSummary))

// Delete imported Applications.
for _, apps := range gotApps {
assert.Must(t, Application.Delete(apps.ID))
}

// Delete imported Dependencies.
for _, deps := range gotDeps {
assert.Must(t, Dependency.Delete(deps.ID))
}
khareyash05 marked this conversation as resolved.
Show resolved Hide resolved
})
}
}
27 changes: 27 additions & 0 deletions test/api/importcsv/pkg.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package importcsv

import (
"github.com/konveyor/tackle2-hub/binding"
"github.com/konveyor/tackle2-hub/test/api/client"
)

var (
RichClient *binding.RichClient
Client *binding.Client
Application binding.Application
Dependency binding.Dependency
)

func init() {
// Prepare RichClient and login to Hub API (configured from env variables).
RichClient = client.PrepareRichClient()

// Access REST client directly
Client = RichClient.Client

// Access Application directly
Application = RichClient.Application

// Access Dependency directly
Dependency = RichClient.Dependency
}
137 changes: 137 additions & 0 deletions test/api/importcsv/samples.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
package importcsv

import (
"github.com/konveyor/tackle2-hub/api"
)

type TestCase struct {
FileName string
ExpectedApplications []api.Application
ExpectedDependencies []api.Dependency
}

var (
TestCases = []TestCase{
{
FileName: "template_application_import.csv",
ExpectedApplications: []api.Application{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This array looks good, please go ahead and add Application fields data from the CSV.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the data in this CSV is supposed to be equivalent to what is being described in the template_application_import.csv?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the data in this CSV is supposed to be equivalent to what is being described in the template_application_import.csv?

Ya even I think so because we are checking that if all the entities are being uploaded or not thus have to check them all

{
Name: "Customers",
Description: "Legacy Customers management service",
Bucket: &api.Ref{},
Repository: &api.Repository{
Kind: "git",
URL: "https://git-acme.local/customers.git",
Branch: "",
Tag: "",
Path: "",
},
Binary: "corp.acme.demo:customers-tomcat:0.0.1-SNAPSHOT:war",
Tags: []api.TagRef{
{
Name: "Oracle",
Source: "",
},
{
Name: "Java",
Source: "",
},
{
Name: "RHEL 8",
Source: "",
},
{
Name: "Tomcat",
Source: "",
},
},
BusinessService: &api.Ref{
Name: "Retail",
},
},
{
Name: "Inventory",
Description: "Inventory service",
Bucket: &api.Ref{},
Repository: &api.Repository{
Kind: "git",
URL: "https://git-acme.local/inventory.git",
Branch: "",
Tag: "",
Path: "",
},
Binary: "corp.acme.demo:inventory:0.1.1-SNAPSHOT:war",
Tags: []api.TagRef{
{
Name: "PostgreSQL",
Source: "",
},
{
Name: "Java",
Source: "",
},
{
Name: "RHEL 8",
Source: "",
},
{
Name: "Quarkus",
Source: "",
},
},
BusinessService: &api.Ref{
Name: "Retail",
},
},
{
Name: "Gateway",
Description: "API Gateway",
Bucket: &api.Ref{},
Repository: &api.Repository{
Kind: "git",
URL: "https://git-acme.local/gateway.git",
Branch: "",
Tag: "",
Path: "",
},
Binary: "corp.acme.demo:gateway:0.1.1-SNAPSHOT:war",
Tags: []api.TagRef{
{
Name: "Java",
Source: "",
},
{
Name: "RHEL 8",
Source: "",
},
{
Name: "Spring Boot",
Source: "",
},
},
BusinessService: &api.Ref{
Name: "Retail",
},
},
},
ExpectedDependencies: []api.Dependency{
{
To: api.Ref{
Name: "Inventory",
},
From: api.Ref{
Name: "Gateway",
},
},
{
To: api.Ref{
Name: "Customers",
},
From: api.Ref{
Name: "Gateway",
},
},
},
},
}
)
Loading