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

Move all documentation examples to separate test files #3055

Merged
merged 36 commits into from
Feb 11, 2025

Conversation

jbrinkman
Copy link
Collaborator

All of the individual examples in the doc comments have been removed and added to test files. The examples have been named so that they will automatically be merged with the documentation is generated by pkgsite. Individual examples have also been fleshed out so that they are fully executable code. The example tests now reside in test files associate with each of the various command interfaces. The example files include:

  • bitmap_commands_test.go
  • config_test.go
  • connection_management_commands_test.go
  • generic_base_commands_test.go
  • generic_commands_test.go
  • hash_commands_test.go
  • hyperloglog_commands_test.go
  • list_commands_test.go
  • server_management_commands_test.go
  • set_commands_test.go
  • sorted_set_commands_test.go
  • stream_commands_test.go
  • string_commands_test.go

Issue link

This Pull Request is linked to issue (#2828)

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one issue.
  • Commit message has a detailed description of what changed and why.
  • Tests are added or updated.
  • CHANGELOG.md and documentation files are updated.
  • Destination branch is correct - main or release
  • Create merge commit if merging release branch into main, squash otherwise.

@jbrinkman jbrinkman requested a review from a team as a code owner February 4, 2025 01:32
@Yury-Fridlyand Yury-Fridlyand added go golang wrapper docs Documentation labels Feb 4, 2025
Copy link
Collaborator

@Yury-Fridlyand Yury-Fridlyand left a comment

Choose a reason for hiding this comment

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

Great job!
Could you please post a screenshot or a PDF of a generated doc?

go/api/bitmap_commands_test.go Show resolved Hide resolved
go/api/bitmap_commands_test.go Show resolved Hide resolved
go/api/stream_commands_test.go Outdated Show resolved Hide resolved
go/api/stream_commands_test.go Outdated Show resolved Hide resolved
Copy link
Collaborator Author

@jbrinkman jbrinkman left a comment

Choose a reason for hiding this comment

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

There are failing tests in the examples. You can see the failing tests by running go test -v -race ./...

=== RUN   TestDefaultStandaloneConfig
--- PASS: TestDefaultStandaloneConfig (0.00s)
=== RUN   TestDefaultClusterConfig
--- PASS: TestDefaultClusterConfig (0.00s)
=== RUN   TestConfig_allFieldsSet
--- PASS: TestConfig_allFieldsSet (0.00s)
=== RUN   TestNodeAddress
=== RUN   TestNodeAddress/Testing_[0]
=== RUN   TestNodeAddress/Testing_[1]
=== RUN   TestNodeAddress/Testing_[2]
=== RUN   TestNodeAddress/Testing_[3]
--- PASS: TestNodeAddress (0.00s)
    --- PASS: TestNodeAddress/Testing_[0] (0.00s)
    --- PASS: TestNodeAddress/Testing_[1] (0.00s)
    --- PASS: TestNodeAddress/Testing_[2] (0.00s)
    --- PASS: TestNodeAddress/Testing_[3] (0.00s)
=== RUN   TestServerCredentials
=== RUN   TestServerCredentials/Testing_[0]
=== RUN   TestServerCredentials/Testing_[1]
--- PASS: TestServerCredentials (0.00s)
    --- PASS: TestServerCredentials/Testing_[0] (0.00s)
    --- PASS: TestServerCredentials/Testing_[1] (0.00s)
=== RUN   ExampleGlideClient_SetBit
--- PASS: ExampleGlideClient_SetBit (0.02s)
=== RUN   ExampleGlideClient_GetBit
--- FAIL: ExampleGlideClient_GetBit (0.00s)
got:
0
want:
1
=== RUN   ExampleGlideClient_BitCount
--- PASS: ExampleGlideClient_BitCount (0.01s)
=== RUN   ExampleGlideClient_BitCountWithOptions
--- PASS: ExampleGlideClient_BitCountWithOptions (0.00s)
=== RUN   ExampleGlideClient_Ping
--- PASS: ExampleGlideClient_Ping (0.00s)
=== RUN   ExampleGlideClient_Echo
--- PASS: ExampleGlideClient_Echo (0.00s)
=== RUN   ExampleGlideClient_Del
--- PASS: ExampleGlideClient_Del (0.00s)
=== RUN   ExampleGlideClient_Exists
--- PASS: ExampleGlideClient_Exists (0.00s)
=== RUN   ExampleGlideClient_Expire
--- PASS: ExampleGlideClient_Expire (0.00s)
=== RUN   ExampleGlideClient_ExpireWithOptions
--- PASS: ExampleGlideClient_ExpireWithOptions (0.00s)
=== RUN   ExampleGlideClient_ExpireAt
--- PASS: ExampleGlideClient_ExpireAt (0.00s)
=== RUN   ExampleGlideClient_ExpireAtWithOptions
--- PASS: ExampleGlideClient_ExpireAtWithOptions (0.00s)
=== RUN   ExampleGlideClient_PExpire
--- PASS: ExampleGlideClient_PExpire (0.01s)
=== RUN   ExampleGlideClient_PExpireWithOptions
--- PASS: ExampleGlideClient_PExpireWithOptions (0.01s)
=== RUN   ExampleGlideClient_PExpireAt
--- PASS: ExampleGlideClient_PExpireAt (0.00s)
=== RUN   ExampleGlideClient_PExpireAtWithOptions
--- PASS: ExampleGlideClient_PExpireAtWithOptions (0.00s)
=== RUN   ExampleGlideClient_ExpireTime
--- PASS: ExampleGlideClient_ExpireTime (0.00s)
=== RUN   ExampleGlideClient_PExpireTime
--- PASS: ExampleGlideClient_PExpireTime (0.00s)
=== RUN   ExampleGlideClient_TTL
--- PASS: ExampleGlideClient_TTL (0.00s)
=== RUN   ExampleGlideClient_PTTL
--- PASS: ExampleGlideClient_PTTL (0.00s)
=== RUN   ExampleGlideClient_Unlink
--- PASS: ExampleGlideClient_Unlink (0.00s)
=== RUN   ExampleGlideClient_Touch
--- PASS: ExampleGlideClient_Touch (0.01s)
=== RUN   ExampleGlideClient_Type
--- PASS: ExampleGlideClient_Type (0.00s)
=== RUN   ExampleGlideClient_Rename
--- PASS: ExampleGlideClient_Rename (0.01s)
=== RUN   ExampleGlideClient_Renamenx
--- PASS: ExampleGlideClient_Renamenx (0.00s)
=== RUN   ExampleGlideClient_Persist
--- PASS: ExampleGlideClient_Persist (0.00s)
=== RUN   ExampleGlideClient_Restore
--- PASS: ExampleGlideClient_Restore (0.00s)
=== RUN   ExampleGlideClient_RestoreWithOptions
--- PASS: ExampleGlideClient_RestoreWithOptions (0.01s)
=== RUN   ExampleGlideClient_ObjectEncoding
--- PASS: ExampleGlideClient_ObjectEncoding (0.01s)
=== RUN   ExampleGlideClient_Dump
--- PASS: ExampleGlideClient_Dump (0.00s)
=== RUN   ExampleGlideClient_ObjectFreq
--- FAIL: ExampleGlideClient_ObjectFreq (0.00s)
got:
OK
{6 false}
want:
OK
{2 false}
=== RUN   ExampleGlideClient_ObjectIdleTime
--- PASS: ExampleGlideClient_ObjectIdleTime (0.00s)
=== RUN   ExampleGlideClient_ObjectRefCount
--- PASS: ExampleGlideClient_ObjectRefCount (0.00s)
=== RUN   ExampleGlideClient_Sort
--- PASS: ExampleGlideClient_Sort (0.01s)
=== RUN   ExampleGlideClient_SortWithOptions
--- PASS: ExampleGlideClient_SortWithOptions (0.00s)
=== RUN   ExampleGlideClient_SortStore
--- PASS: ExampleGlideClient_SortStore (0.00s)
=== RUN   ExampleGlideClient_SortStoreWithOptions
--- PASS: ExampleGlideClient_SortStoreWithOptions (0.00s)
=== RUN   ExampleGlideClient_SortReadOnly
--- PASS: ExampleGlideClient_SortReadOnly (0.00s)
=== RUN   ExampleGlideClient_SortReadOnlyWithOptions
--- PASS: ExampleGlideClient_SortReadOnlyWithOptions (0.01s)
=== RUN   ExampleGlideClient_Wait
--- PASS: ExampleGlideClient_Wait (2.03s)
=== RUN   ExampleGlideClient_Copy
--- PASS: ExampleGlideClient_Copy (0.02s)
=== RUN   ExampleGlideClient_CopyWithOptions
--- FAIL: ExampleGlideClient_CopyWithOptions (0.01s)
got:
OK
true
{ true}
want:
OK
true
{someValue false}
=== RUN   ExampleGlideClient_CustomCommand
--- PASS: ExampleGlideClient_CustomCommand (0.01s)
=== RUN   ExampleGlideClient_HGet
--- PASS: ExampleGlideClient_HGet (0.01s)
=== RUN   ExampleGlideClient_HGetAll
--- PASS: ExampleGlideClient_HGetAll (0.01s)
=== RUN   ExampleGlideClient_HMGet
--- PASS: ExampleGlideClient_HMGet (0.01s)
=== RUN   ExampleGlideClient_HSet
--- PASS: ExampleGlideClient_HSet (0.01s)
=== RUN   ExampleGlideClient_HSetNX
--- PASS: ExampleGlideClient_HSetNX (0.01s)
=== RUN   ExampleGlideClient_HDel
--- PASS: ExampleGlideClient_HDel (0.01s)
=== RUN   ExampleGlideClient_HLen
--- PASS: ExampleGlideClient_HLen (0.01s)
=== RUN   ExampleGlideClient_HVals
--- PASS: ExampleGlideClient_HVals (0.01s)
=== RUN   ExampleGlideClient_HExists
--- PASS: ExampleGlideClient_HExists (0.00s)
=== RUN   ExampleGlideClient_HKeys
--- PASS: ExampleGlideClient_HKeys (0.02s)
=== RUN   ExampleGlideClient_HStrLen
--- PASS: ExampleGlideClient_HStrLen (0.01s)
=== RUN   ExampleGlideClient_HIncrBy
--- PASS: ExampleGlideClient_HIncrBy (0.01s)
=== RUN   ExampleGlideClient_HIncrByFloat
--- PASS: ExampleGlideClient_HIncrByFloat (0.01s)
=== RUN   ExampleGlideClient_HScan
--- PASS: ExampleGlideClient_HScan (0.01s)
=== RUN   ExampleGlideClient_HRandField
--- FAIL: ExampleGlideClient_HRandField (0.01s)
got:
1
{field1 false}
want:
2
{field1 false}
=== RUN   ExampleGlideClient_HRandFieldWithCount
--- FAIL: ExampleGlideClient_HRandFieldWithCount (0.01s)
got:
2
[field2 field1]
want:
2
[field1 field2]
=== RUN   ExampleGlideClient_HRandFieldWithCountWithValues
--- PASS: ExampleGlideClient_HRandFieldWithCountWithValues (0.01s)
=== RUN   ExampleGlideClient_HScanWithOptions
--- PASS: ExampleGlideClient_HScanWithOptions (0.01s)
=== RUN   ExampleGlideClient_PfAdd
--- PASS: ExampleGlideClient_PfAdd (0.01s)
=== RUN   ExampleGlideClient_PfCount
--- PASS: ExampleGlideClient_PfCount (0.01s)
=== RUN   ExampleGlideClient_LPush
--- PASS: ExampleGlideClient_LPush (0.01s)
=== RUN   ExampleGlideClient_LPop
--- PASS: ExampleGlideClient_LPop (0.01s)
=== RUN   ExampleGlideClient_LPopCount
--- PASS: ExampleGlideClient_LPopCount (0.01s)
=== RUN   ExampleGlideClient_LPos
--- PASS: ExampleGlideClient_LPos (0.01s)
=== RUN   ExampleGlideClient_LPosWithOptions
--- PASS: ExampleGlideClient_LPosWithOptions (0.01s)
=== RUN   ExampleGlideClient_LPosCount
--- PASS: ExampleGlideClient_LPosCount (0.00s)
=== RUN   ExampleGlideClient_LPosCountWithOptions
--- PASS: ExampleGlideClient_LPosCountWithOptions (0.01s)
=== RUN   ExampleGlideClient_RPush
--- PASS: ExampleGlideClient_RPush (0.01s)
=== RUN   ExampleGlideClient_LRange
--- PASS: ExampleGlideClient_LRange (0.01s)
=== RUN   ExampleGlideClient_LIndex
--- PASS: ExampleGlideClient_LIndex (0.01s)
=== RUN   ExampleGlideClient_LTrim
--- PASS: ExampleGlideClient_LTrim (0.01s)
=== RUN   ExampleGlideClient_LLen
--- PASS: ExampleGlideClient_LLen (0.01s)
=== RUN   ExampleGlideClient_LRem
--- PASS: ExampleGlideClient_LRem (0.01s)
=== RUN   ExampleGlideClient_RPop
--- PASS: ExampleGlideClient_RPop (0.00s)
=== RUN   ExampleGlideClient_RPopCount
--- PASS: ExampleGlideClient_RPopCount (0.00s)
=== RUN   ExampleGlideClient_LInsert
--- PASS: ExampleGlideClient_LInsert (0.00s)
=== RUN   ExampleGlideClient_BLPop
--- PASS: ExampleGlideClient_BLPop (0.00s)
=== RUN   ExampleGlideClient_BRPop
--- PASS: ExampleGlideClient_BRPop (0.00s)
=== RUN   ExampleGlideClient_RPushX
--- PASS: ExampleGlideClient_RPushX (0.01s)
=== RUN   ExampleGlideClient_LPushX
--- PASS: ExampleGlideClient_LPushX (0.00s)
=== RUN   ExampleGlideClient_LMPop
--- PASS: ExampleGlideClient_LMPop (0.00s)
=== RUN   ExampleGlideClient_LMPopCount
--- PASS: ExampleGlideClient_LMPopCount (0.00s)
=== RUN   ExampleGlideClient_BLMPop
--- PASS: ExampleGlideClient_BLMPop (0.00s)
=== RUN   ExampleGlideClient_BLMPopCount
--- PASS: ExampleGlideClient_BLMPopCount (0.00s)
=== RUN   ExampleGlideClient_LSet
--- PASS: ExampleGlideClient_LSet (0.00s)
=== RUN   ExampleGlideClient_LMove
--- PASS: ExampleGlideClient_LMove (0.00s)
=== RUN   ExampleGlideClient_BLMove
--- PASS: ExampleGlideClient_BLMove (0.01s)
=== RUN   ExampleGlideClient_Select
--- PASS: ExampleGlideClient_Select (0.00s)
=== RUN   ExampleGlideClient_ConfigGet
--- PASS: ExampleGlideClient_ConfigGet (0.01s)
=== RUN   ExampleGlideClient_ConfigSet
--- PASS: ExampleGlideClient_ConfigSet (0.00s)
=== RUN   ExampleGlideClient_DBSize
--- PASS: ExampleGlideClient_DBSize (0.00s)
=== RUN   ExampleGlideClient_SAdd
--- PASS: ExampleGlideClient_SAdd (0.00s)
=== RUN   ExampleGlideClient_SRem
--- FAIL: ExampleGlideClient_SRem (0.00s)
got:
0
want:
2
=== RUN   ExampleGlideClient_SMembers
--- PASS: ExampleGlideClient_SMembers (0.00s)
=== RUN   ExampleGlideClient_SCard
--- PASS: ExampleGlideClient_SCard (0.00s)
=== RUN   ExampleGlideClient_SIsMember
--- PASS: ExampleGlideClient_SIsMember (0.00s)
=== RUN   ExampleGlideClient_SDiff
--- PASS: ExampleGlideClient_SDiff (0.00s)
=== RUN   ExampleGlideClient_SDiffStore
--- PASS: ExampleGlideClient_SDiffStore (0.00s)
=== RUN   ExampleGlideClient_SInter
--- PASS: ExampleGlideClient_SInter (0.00s)
=== RUN   ExampleGlideClient_SInterStore
--- PASS: ExampleGlideClient_SInterStore (0.00s)
=== RUN   ExampleGlideClient_SInterCard
--- PASS: ExampleGlideClient_SInterCard (0.00s)
=== RUN   ExampleGlideClient_SInterCardLimit
--- PASS: ExampleGlideClient_SInterCardLimit (0.01s)
=== RUN   ExampleGlideClient_SRandMember
--- PASS: ExampleGlideClient_SRandMember (0.00s)
=== RUN   ExampleGlideClient_SPop
--- PASS: ExampleGlideClient_SPop (0.00s)
=== RUN   ExampleGlideClient_SMIsMember
--- PASS: ExampleGlideClient_SMIsMember (0.00s)
=== RUN   ExampleGlideClient_SUnionStore
--- PASS: ExampleGlideClient_SUnionStore (0.00s)
=== RUN   ExampleGlideClient_SUnion
--- PASS: ExampleGlideClient_SUnion (0.00s)
=== RUN   ExampleGlideClient_SScan
--- PASS: ExampleGlideClient_SScan (0.00s)
=== RUN   ExampleGlideClient_SScanWithOptions
--- PASS: ExampleGlideClient_SScanWithOptions (0.00s)
=== RUN   ExampleGlideClient_SMove
--- PASS: ExampleGlideClient_SMove (0.00s)
=== RUN   ExampleGlideClient_ZAdd
--- PASS: ExampleGlideClient_ZAdd (0.00s)
=== RUN   ExampleGlideClient_ZAddWithOptions
--- PASS: ExampleGlideClient_ZAddWithOptions (0.00s)
=== RUN   ExampleGlideClient_ZAddIncr
--- PASS: ExampleGlideClient_ZAddIncr (0.00s)
=== RUN   ExampleGlideClient_ZAddIncrWithOptions
--- PASS: ExampleGlideClient_ZAddIncrWithOptions (0.02s)
=== RUN   ExampleGlideClient_ZIncrBy
--- PASS: ExampleGlideClient_ZIncrBy (0.00s)
=== RUN   ExampleGlideClient_ZPopMin
--- PASS: ExampleGlideClient_ZPopMin (0.01s)
=== RUN   ExampleGlideClient_ZPopMinWithCount
--- PASS: ExampleGlideClient_ZPopMinWithCount (0.00s)
=== RUN   ExampleGlideClient_ZPopMax
--- PASS: ExampleGlideClient_ZPopMax (0.00s)
=== RUN   ExampleGlideClient_ZPopMaxWithCount
--- PASS: ExampleGlideClient_ZPopMaxWithCount (0.00s)
=== RUN   ExampleGlideClient_ZRem
--- PASS: ExampleGlideClient_ZRem (0.00s)
=== RUN   ExampleGlideClient_ZCard
--- PASS: ExampleGlideClient_ZCard (0.01s)
=== RUN   ExampleGlideClient_BZPopMin
--- PASS: ExampleGlideClient_BZPopMin (0.00s)
=== RUN   ExampleGlideClient_ZRange
--- PASS: ExampleGlideClient_ZRange (0.00s)
=== RUN   ExampleGlideClient_ZRangeWithScores
--- PASS: ExampleGlideClient_ZRangeWithScores (0.00s)
=== RUN   ExampleGlideClient_ZRank
--- PASS: ExampleGlideClient_ZRank (0.00s)
=== RUN   ExampleGlideClient_ZRankWithScore
--- PASS: ExampleGlideClient_ZRankWithScore (0.00s)
=== RUN   ExampleGlideClient_ZRevRank
--- PASS: ExampleGlideClient_ZRevRank (0.00s)
=== RUN   ExampleGlideClient_ZRevRankWithScore
--- PASS: ExampleGlideClient_ZRevRankWithScore (0.00s)
=== RUN   ExampleGlideClient_ZScore
--- PASS: ExampleGlideClient_ZScore (0.00s)
=== RUN   ExampleGlideClient_ZCount
--- PASS: ExampleGlideClient_ZCount (0.02s)
=== RUN   ExampleGlideClient_ZScan
--- PASS: ExampleGlideClient_ZScan (0.00s)
=== RUN   ExampleGlideClient_ZScanWithOptions
--- PASS: ExampleGlideClient_ZScanWithOptions (0.00s)
=== RUN   ExampleGlideClient_ZRemRangeByLex
--- PASS: ExampleGlideClient_ZRemRangeByLex (0.00s)
=== RUN   ExampleGlideClient_ZRemRangeByRank
--- PASS: ExampleGlideClient_ZRemRangeByRank (0.00s)
=== RUN   ExampleGlideClient_ZRemRangeByScore
--- PASS: ExampleGlideClient_ZRemRangeByScore (0.00s)
=== RUN   ExampleGlideClient_BZMPop
--- PASS: ExampleGlideClient_BZMPop (0.00s)
=== RUN   ExampleGlideClient_BZMPopWithOptions
--- FAIL: ExampleGlideClient_BZMPopWithOptions (0.00s)
got:
{"Key":"key1","MembersAndScores":[{"Member":"d","Score":4},{"Member":"c","Score":3}]}
want:
{"Key":"key1","MembersAndScores":[{"Member":"c","Score":3},{"Member":"d","Score":4}]}
=== RUN   ExampleGlideClient_XAdd
--- PASS: ExampleGlideClient_XAdd (0.00s)
=== RUN   ExampleGlideClient_XAddWithOptions
--- PASS: ExampleGlideClient_XAddWithOptions (0.00s)
=== RUN   ExampleGlideClient_XTrim
--- FAIL: ExampleGlideClient_XTrim (0.00s)
got:
2
want:
1
=== RUN   ExampleGlideClient_XLen
--- PASS: ExampleGlideClient_XLen (0.00s)
=== RUN   ExampleGlideClient_XAutoClaim
--- FAIL: ExampleGlideClient_XAutoClaim (0.01s)
got:
{0-0 map[0-1:[[entry1_field1 entry1_value1] [entry1_field2 entry1_value2]] 0-2:[[entry2_field1 entry2_value1]]] []}
want:
{0-0 map[0-1:[[entry1_field1 entry1_value1] [entry1_field2 entry1_value2]] 0-2:[[entry2_field1 entry2_value1]]]
[]}
=== RUN   ExampleGlideClient_XAutoClaimWithOptions
--- PASS: ExampleGlideClient_XAutoClaimWithOptions (0.00s)
=== RUN   ExampleGlideClient_XAutoClaimJustId
--- PASS: ExampleGlideClient_XAutoClaimJustId (0.01s)
=== RUN   ExampleGlideClient_XAutoClaimJustIdWithOptions
--- PASS: ExampleGlideClient_XAutoClaimJustIdWithOptions (0.00s)
=== RUN   ExampleGlideClient_XReadGroup
--- PASS: ExampleGlideClient_XReadGroup (0.00s)
=== RUN   ExampleGlideClient_XReadGroupWithOptions
--- PASS: ExampleGlideClient_XReadGroupWithOptions (0.00s)
=== RUN   ExampleGlideClient_XRead
--- PASS: ExampleGlideClient_XRead (0.00s)
=== RUN   ExampleGlideClient_XReadWithOptions
--- FAIL: ExampleGlideClient_XReadWithOptions (0.00s)
got:
map[12345:map[12345-2:[[field3 value3] [field4 value4]]]]
want:
map[12345:map[12345-1:[[field1 value1] [field2 value2]]]]
=== RUN   ExampleGlideClient_XDel
--- PASS: ExampleGlideClient_XDel (0.00s)
=== RUN   ExampleGlideClient_XPending
--- PASS: ExampleGlideClient_XPending (0.00s)
=== RUN   ExampleGlideClient_XPendingWithOptions
--- FAIL: ExampleGlideClient_XPendingWithOptions (0.00s)
got:
[{"Id":"12345-1","ConsumerName":"c12345","IdleTime":0,"DeliveryCount":1}]
want:
[{"Id":"12345-1","ConsumerName":"c12345","IdleTime":1,"DeliveryCount":1}]
=== RUN   ExampleGlideClient_XGroupSetId
--- PASS: ExampleGlideClient_XGroupSetId (0.00s)
=== RUN   ExampleGlideClient_XGroupSetIdWithOptions
--- FAIL: ExampleGlideClient_XGroupSetIdWithOptions (0.00s)
got:
{"NumOfMessages":0,"StartId":{},"EndId":{},"ConsumerMessages":[]}
want:
{"NumOfMessages":1,"StartId":{},"EndId":{},"ConsumerMessages":[{"ConsumerName":"c12345","MessageCount":1}]}
=== RUN   ExampleGlideClient_XGroupCreate
--- PASS: ExampleGlideClient_XGroupCreate (0.00s)
=== RUN   ExampleGlideClient_XGroupCreateWithOptions
--- PASS: ExampleGlideClient_XGroupCreateWithOptions (0.00s)
=== RUN   ExampleGlideClient_XGroupDestroy
--- PASS: ExampleGlideClient_XGroupDestroy (0.00s)
=== RUN   ExampleGlideClient_XGroupCreateConsumer
--- PASS: ExampleGlideClient_XGroupCreateConsumer (0.00s)
=== RUN   ExampleGlideClient_XGroupDelConsumer
--- PASS: ExampleGlideClient_XGroupDelConsumer (0.00s)
=== RUN   ExampleGlideClient_XAck
--- PASS: ExampleGlideClient_XAck (0.00s)
=== RUN   ExampleGlideClient_XClaim
--- FAIL: ExampleGlideClient_XClaim (0.00s)
got:
Claimed 0 message
want:
Claimed 1 message
=== RUN   ExampleGlideClient_XClaimWithOptions
--- FAIL: ExampleGlideClient_XClaimWithOptions (0.00s)
got:
Claimed 0 message
want:
Claimed 1 message
=== RUN   ExampleGlideClient_XClaimJustId
--- FAIL: ExampleGlideClient_XClaimJustId (0.01s)
got:
[]
want:
[12345-1]
=== RUN   ExampleGlideClient_XClaimJustIdWithOptions
--- PASS: ExampleGlideClient_XClaimJustIdWithOptions (0.00s)
=== RUN   ExampleGlideClient_XRangeWithOptions
--- PASS: ExampleGlideClient_XRangeWithOptions (0.00s)
=== RUN   ExampleGlideClient_Set
--- PASS: ExampleGlideClient_Set (0.00s)
=== RUN   ExampleGlideClient_SetWithOptions
--- PASS: ExampleGlideClient_SetWithOptions (0.00s)
=== RUN   ExampleGlideClient_Get_keyexists
--- PASS: ExampleGlideClient_Get_keyexists (0.00s)
=== RUN   ExampleGlideClient_Get_keynotexists
--- PASS: ExampleGlideClient_Get_keynotexists (0.00s)
=== RUN   ExampleGlideClient_GetEx
--- PASS: ExampleGlideClient_GetEx (0.00s)
=== RUN   ExampleGlideClient_GetExWithOptions
--- PASS: ExampleGlideClient_GetExWithOptions (0.00s)
=== RUN   ExampleGlideClient_MSet
--- PASS: ExampleGlideClient_MSet (0.00s)
=== RUN   ExampleGlideClient_MGet
--- PASS: ExampleGlideClient_MGet (0.00s)
=== RUN   ExampleGlideClient_MSetNX
--- PASS: ExampleGlideClient_MSetNX (0.00s)
=== RUN   ExampleGlideClient_Incr
--- PASS: ExampleGlideClient_Incr (0.00s)
=== RUN   ExampleGlideClient_IncrBy
--- PASS: ExampleGlideClient_IncrBy (0.00s)
=== RUN   ExampleGlideClient_IncrByFloat
--- PASS: ExampleGlideClient_IncrByFloat (0.00s)
=== RUN   ExampleGlideClient_Decr
--- PASS: ExampleGlideClient_Decr (0.00s)
=== RUN   ExampleGlideClient_DecrBy
--- PASS: ExampleGlideClient_DecrBy (0.00s)
=== RUN   ExampleGlideClient_Strlen
--- PASS: ExampleGlideClient_Strlen (0.00s)
=== RUN   ExampleGlideClient_SetRange_one
--- PASS: ExampleGlideClient_SetRange_one (0.01s)
=== RUN   ExampleGlideClient_SetRange_two
--- PASS: ExampleGlideClient_SetRange_two (0.00s)
=== RUN   ExampleGlideClient_GetRange_one
--- PASS: ExampleGlideClient_GetRange_one (0.00s)
=== RUN   ExampleGlideClient_GetRange_two
--- PASS: ExampleGlideClient_GetRange_two (0.00s)
=== RUN   ExampleGlideClient_Append
--- PASS: ExampleGlideClient_Append (0.00s)
=== RUN   ExampleGlideClient_LCS
--- PASS: ExampleGlideClient_LCS (0.00s)
=== RUN   ExampleGlideClient_GetDel
--- PASS: ExampleGlideClient_GetDel (0.00s)
FAIL
FAIL    github.com/valkey-io/valkey-glide/go/glide/api  3.245s

cc: @edlng

@Yury-Fridlyand
Copy link
Collaborator

Consider updating developer guide with instructions.

@edlng
Copy link
Contributor

edlng commented Feb 4, 2025

Got it. I can work on fixing the test failures

go/Makefile Outdated Show resolved Hide resolved
@jamesx-improving
Copy link
Collaborator

After the Go CD pipeline merge, please rebase and then do a global search, make sure there's no longer any existence of below string:

github.com/valkey-io/valkey-glide/go/glide

If there's any, replace it with:

github.com/valkey-io/valkey-glide/go

go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/base_client.go Outdated Show resolved Hide resolved
go/api/config.go Show resolved Hide resolved
go/api/config.go Show resolved Hide resolved
go/api/config.go Show resolved Hide resolved
go/api/config.go Show resolved Hide resolved
go/api/example_utils.go Outdated Show resolved Hide resolved
go/api/hash_commands_test.go Show resolved Hide resolved
jbrinkman and others added 22 commits February 10, 2025 19:46
Signed-off-by: jbrinkman <[email protected]>
Signed-off-by: jbrinkman <[email protected]>
Signed-off-by: Edward Liang <[email protected]>
Signed-off-by: jbrinkman <[email protected]>

# Conflicts:
#	go/Makefile
#	go/api/generic_base_commands_test.go
#	go/api/stream_commands_test.go
Signed-off-by: jbrinkman <[email protected]>
Signed-off-by: jbrinkman <[email protected]>
Co-authored-by: Edward Liang <[email protected]>
Signed-off-by: Joseph Brinkman <[email protected]>
Co-authored-by: Edward Liang <[email protected]>
Signed-off-by: Joseph Brinkman <[email protected]>
Co-authored-by: Edward Liang <[email protected]>
Signed-off-by: Joseph Brinkman <[email protected]>
Co-authored-by: Edward Liang <[email protected]>
Signed-off-by: Joseph Brinkman <[email protected]>
@jbrinkman jbrinkman merged commit 468150a into main Feb 11, 2025
17 of 18 checks passed
@jbrinkman jbrinkman deleted the go/jbrinkman-doc-examples branch February 11, 2025 13:14
jbrinkman added a commit that referenced this pull request Feb 11, 2025
* add initial framework examples

Signed-off-by: Joseph Brinkman <[email protected]>
Co-authored-by: Edward Liang <[email protected]>
Signed-off-by: jbrinkman <[email protected]>

# Conflicts:
#	go/api/base_client.go
Yury-Fridlyand added a commit that referenced this pull request Feb 11, 2025
…#3055) (#3132)

* Move all documentation examples to separate test files (#3055)

---------

Signed-off-by: jbrinkman <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation go golang wrapper
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants