chore: Adjust integration tests after moving to separate package #2115

sfc-gh-asawicki · 2023-10-11T16:25:30Z

This is the second PR to have SDK integration tests in a separate package. It is a continuation of #2111. It deals with the previous discussions and addresses the topics mentioned in the last PR.

Changes

deal with the contents of integration_test_imports.go file:
- there is only one method left (with the comment)
- errors exported from sdk
- getter methods added to some request structs
- validation method extracted
deal with two random.go files
- random.go from the integration tests package is entirely removed
- common randoms are moved to pkg/sdk/internal/random.go
- SDK-specific random helpers are left with a comment in the sdk package
- all randomX functions signatures were changed (t parameter was removed)
generator templates and code had to be adjusted to methods moved and/or renamed

Next steps (for subsequent PRs) - summarized:

decide what is the right way to reuse client throughout the tests (currently accessor function testClient vs. itc.client vs. top-level client vs. something else?); the same with the testContext function
decide what to do with sweepers
the tests were only moved, and so the common setup was not extracted:
- we can extract setting up database/schema to the testMain method
- we can merge separate functions in a single file to have fewer setup steps

Test Plan

unit tests (nothing should break)
integration tests (the essence of the tests was not changed, so they should pass)
acceptance tests (nothing should break)

References

github-actions · 2023-10-11T16:39:42Z

Integration tests failure for d5a2ab72820865419a9a06fdb734b67548252bac

github-actions · 2023-10-12T07:23:11Z

Integration tests success for 8f2f53429bb52f42761e8f675da5c62f8e817204

pkg/sdk/database_role_test.go

sfc-gh-swinkler · 2023-10-12T07:38:05Z

pkg/sdk/database_role_test.go

@@ -15,13 +17,13 @@ func TestDatabaseRoleCreate(t *testing.T) {

 	t.Run("validation: nil options", func(t *testing.T) {
 		var opts *createDatabaseRoleOptions = nil
-		assertOptsInvalidJoinedErrors(t, opts, errNilOptions)
+		assertOptsInvalidJoinedErrors(t, opts, ErrNilOptions)


should errors also be move into the internal package? Especially since jan is going to do some work with that. i guess it work make package imports weird. like errors.ErrNilOptions, also golang doesn't like it when you overwrite the standard package names

I would not go with moving them to internal because it may be a use case for SDK users to compare the error they got with the reference error to decide on the next steps of execution. That's why they are just exported, as we have discussed in #2111 (comment).

pkg/sdk/internal/collections/collection_helpers.go

sfc-gh-swinkler · 2023-10-12T07:45:31Z

pkg/sdk/internal/random/random_helpers.go

+	"github.com/stretchr/testify/require"
+)
+
+func Uuid(t *testing.T) string {


my friend, this should be UUID

I think we have another discussion coming. :D I strongly prefer having abbreviations written in only the first letter capitalized, but you are right; for now, our codebase has them capitalized, so I will rename them.

github-actions · 2023-10-12T11:57:01Z

Integration tests failure for 9ef8c9f475e4d0231c59a5674fee21dc50aca2ba

github-actions · 2023-10-12T12:01:13Z

Integration tests failure for 8ace52fd02b76cfde5e8ebed272f66bc5591cebf

github-actions · 2023-10-12T12:05:13Z

Integration tests failure for 3d66a3659ab0afb47e62a09389be22d278dadb9a

github-actions · 2023-10-12T12:26:28Z

Integration tests failure for 2c171d9820b4fee5a76a1a893a2bc2968013c6bf

pkg/sdk/poc/README.md

pkg/sdk/random.go

github-actions · 2023-10-12T12:47:14Z

Integration tests failure for 2c171d9820b4fee5a76a1a893a2bc2968013c6bf

github-actions · 2023-10-12T13:11:22Z

Integration tests success for 2c171d9820b4fee5a76a1a893a2bc2968013c6bf

sfc-gh-asawicki requested review from sfc-gh-jcieslak and sfc-gh-swinkler October 12, 2023 07:06

sfc-gh-asawicki marked this pull request as ready for review October 12, 2023 07:30

sfc-gh-swinkler reviewed Oct 12, 2023

View reviewed changes

sfc-gh-asawicki added 13 commits October 12, 2023 13:52

Expose SDK errors

9c9f05d

Add comment for client exec removal

604908d

Move accessor methods to production code

fb1406f

Expose ValidObjectIdentifier function

736af9d

Move findOne to internal SDK package

b17ed3e

Export random functions in SDK

f95b71c

Fix cyclic dependency

ddd249c

Fix generator templates

7b9bf12

Delegate random to sdk exported ones

49e50fb

Use exported random helpers in integration tests

f59da00

Move random helpers to internal package

c013f2f

Clean random files a bit

eaa9c7c

Rename internal packages

5405291

sfc-gh-asawicki added 6 commits October 12, 2023 13:57

Remove random from integration tests package

1c61e79

Update comment

7ea7f78

Add options for random helpers

32333cf

Fix generator templates

8b1e500

Rename random helper functions

7f158ea

Adjust tests

4bb4c59

sfc-gh-asawicki added 2 commits October 12, 2023 14:02

Fix after review

dc9687a

Bump x/net dep

3d66a36

sfc-gh-asawicki force-pushed the integration-tests-separate-package-chores branch from 8ace52f to 3d66a36 Compare October 12, 2023 12:02

sfc-gh-asawicki requested a review from sfc-gh-swinkler October 12, 2023 12:03

Fix build

2c171d9

sfc-gh-jcieslak reviewed Oct 12, 2023

View reviewed changes

pkg/sdk/poc/README.md Show resolved Hide resolved

pkg/sdk/random.go Show resolved Hide resolved

sfc-gh-jcieslak approved these changes Oct 12, 2023

View reviewed changes

sfc-gh-swinkler approved these changes Oct 12, 2023

View reviewed changes

sfc-gh-asawicki merged commit 3f528a8 into main Oct 12, 2023
8 checks passed

sfc-gh-asawicki deleted the integration-tests-separate-package-chores branch October 12, 2023 14:59

snowflake-release-please bot mentioned this pull request Oct 12, 2023

chore(main): release 0.74.0 #2114

Merged

sfc-gh-asawicki mentioned this pull request Oct 12, 2023

chore: Integration tests setup db once #2118

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Adjust integration tests after moving to separate package #2115

chore: Adjust integration tests after moving to separate package #2115

sfc-gh-asawicki commented Oct 11, 2023 •

edited

github-actions bot commented Oct 11, 2023

github-actions bot commented Oct 12, 2023

sfc-gh-swinkler Oct 12, 2023

sfc-gh-asawicki Oct 12, 2023 •

edited

sfc-gh-swinkler Oct 12, 2023

sfc-gh-asawicki Oct 12, 2023

sfc-gh-asawicki Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

chore: Adjust integration tests after moving to separate package #2115

chore: Adjust integration tests after moving to separate package #2115

Conversation

sfc-gh-asawicki commented Oct 11, 2023 • edited

Changes

Next steps (for subsequent PRs) - summarized:

Test Plan

References

github-actions bot commented Oct 11, 2023

github-actions bot commented Oct 12, 2023

sfc-gh-swinkler Oct 12, 2023

Choose a reason for hiding this comment

sfc-gh-asawicki Oct 12, 2023 • edited

Choose a reason for hiding this comment

sfc-gh-swinkler Oct 12, 2023

Choose a reason for hiding this comment

sfc-gh-asawicki Oct 12, 2023

Choose a reason for hiding this comment

sfc-gh-asawicki Oct 12, 2023

Choose a reason for hiding this comment

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

sfc-gh-asawicki commented Oct 11, 2023 •

edited

sfc-gh-asawicki Oct 12, 2023 •

edited