test: add TestGetArrayDimensionality test #1495

TropicalDog17 · 2024-06-15T17:04:47Z

Description

Add TestGetArrayDimensionality and refactor GetArrayDimensionality to correctly handle the empty n-dimension array(old implemetation fail with input like([0][0]int32{}, [][]byte{}) which I believe is not desirable.

Summary by CodeRabbit

Bug Fixes
- Improved handling of empty and nested arrays, ensuring accurate dimensionality determination.
Tests
- Added tests to verify the dimensionality of various types of arrays and slices, covering different scenarios including empty and nested arrays.

coderabbitai · 2024-06-15T17:04:51Z

Walkthrough

The update enhances the GetArrayDimensionality function within the ssz/v2/lib package for accurately determining the dimensionality of N-dimensional arrays, including empty and nested arrays. Additional tests were introduced in determine_size_test.go and serializer_test.go to ensure comprehensive coverage of various array types and dimensions.

Changes

File Path	Summary
`mod/primitives/pkg/ssz/v2/lib/determine_size.go`	Updated `GetArrayDimensionality` function to handle N-dimensional arrays, focusing on empty arrays and nested arrays.
`.../v2/lib/determine_size_test.go`	Added `TestGetArrayDimensionality` function to test array dimensionality functionality, including various array types.
`.../v2/lib/serializer_test.go`	Added `TestGetArrayDimensionality` to test array dimensionality with reflection for different array dimensions and types.

Poem

Amid arrays of every kind,
A function's path we now unwind,
From nested depths to empty space,
Dimensions found, with precise grace.
Tests have come to pave the way,
Ensuring all arrays, where they may sway,
✨A code's delight, in light of day.✨

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between c39920a and b7f0292.

Files selected for processing (2)

mod/primitives/pkg/ssz/v2/lib/determine_size.go (1 hunks)
mod/primitives/pkg/ssz/v2/lib/determine_size_test.go (1 hunks)

Additional comments not posted (2)

mod/primitives/pkg/ssz/v2/lib/determine_size_test.go (1)

37-45: The structure and implementation of the test function are correct and follow best practices for table-driven tests in Go.

mod/primitives/pkg/ssz/v2/lib/determine_size.go (1)

342-367: The logic and performance of the updated GetArrayDimensionality function are sound and efficient.

mod/primitives/pkg/ssz/v2/lib/determine_size_test.go

mod/primitives/pkg/ssz/v2/lib/determine_size.go

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between b7f0292 and 96374c3.

Files selected for processing (1)

mod/primitives/pkg/ssz/v2/lib/serializer_test.go (2 hunks)

Additional comments not posted (1)

mod/primitives/pkg/ssz/v2/lib/serializer_test.go (1)

24-24: The import of the reflect package is crucial for the new test function to work correctly.

mod/primitives/pkg/ssz/v2/lib/serializer_test.go

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 96374c3 and 01a9751.

Files selected for processing (1)

mod/primitives/pkg/ssz/v2/lib/serializer_test.go (2 hunks)

mod/primitives/pkg/ssz/v2/lib/serializer_test.go

codecov · 2024-06-16T16:37:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.45%. Comparing base (9e9da10) to head (a1da418).

❗ Current head a1da418 differs from pull request most recent head 62a59b2

Please upload reports for the commit 62a59b2 to get more accurate results.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #1495       +/-   ##
===========================================
+ Coverage   24.75%   70.45%   +45.70%     
===========================================
  Files         249        8      -241     
  Lines       11228       88    -11140     
  Branches       18       18               
===========================================
- Hits         2779       62     -2717     
+ Misses       8281       22     -8259     
+ Partials      168        4      -164

see 241 files with indirect coverage changes

nidhi-singh02 · 2024-06-17T12:23:36Z

mod/primitives/pkg/ssz/v2/lib/serializer_test.go

@@ -67,3 +68,40 @@ func TestMarshalUnmarshalBoolSerializer(t *testing.T) {
 	unmarshaled := ssz.UnmarshalBool[bool](marshaled)
 	require.Equal(t, original, unmarshaled, "Marshal/Unmarshal Bool failed")
 }
+
+func TestGetArrayDimensionality(t *testing.T) {


Can we separate/group the tests according to their dimensionality to make it readable.

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 01a9751 and fb5c227.

Files selected for processing (1)

mod/primitives/pkg/ssz/v2/lib/serializer_test.go (2 hunks)

mod/primitives/pkg/ssz/v2/lib/serializer_test.go

TropicalDog17 added 2 commits June 16, 2024 00:03

bet

24dd337

add failed case

8973cf7

bet

ae8d1e6

TropicalDog17 marked this pull request as ready for review June 15, 2024 17:09

TropicalDog17 requested review from itsdevbear and ocnc as code owners June 15, 2024 17:09

lint

b7f0292

coderabbitai bot reviewed Jun 15, 2024

View reviewed changes

mod/primitives/pkg/ssz/v2/lib/determine_size_test.go Outdated Show resolved Hide resolved

mod/primitives/pkg/ssz/v2/lib/determine_size.go Show resolved Hide resolved

TropicalDog17 and others added 3 commits June 16, 2024 00:19

remove new file

7cf39b0

feat(ssz): Improve memory efficiency of edge case (#1498)

01279b7

Merge branch 'main' into tuan/add-test-get-array-dimensionality

96374c3

coderabbitai bot reviewed Jun 16, 2024

View reviewed changes

mod/primitives/pkg/ssz/v2/lib/serializer_test.go Outdated Show resolved Hide resolved

itsdevbear force-pushed the main branch from 01279b7 to 70c8129 Compare June 16, 2024 02:56

remove todo

01a9751

coderabbitai bot reviewed Jun 16, 2024

View reviewed changes

mod/primitives/pkg/ssz/v2/lib/serializer_test.go Outdated Show resolved Hide resolved

Merge branch 'main' into tuan/add-test-get-array-dimensionality

a1da418

nidhi-singh02 reviewed Jun 17, 2024

View reviewed changes

TropicalDog17 added 2 commits June 17, 2024 21:47

seperate test by num of dimensional

80578da

Merge branch 'main' into tuan/add-test-get-array-dimensionality

fb5c227

TropicalDog17 requested a review from nidhi-singh02 June 17, 2024 14:47

coderabbitai bot reviewed Jun 17, 2024

View reviewed changes

mod/primitives/pkg/ssz/v2/lib/serializer_test.go Show resolved Hide resolved

Merge branch 'main' into tuan/add-test-get-array-dimensionality

62a59b2

itsdevbear merged commit dede090 into berachain:main Jun 18, 2024
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: add TestGetArrayDimensionality test #1495

test: add TestGetArrayDimensionality test #1495

TropicalDog17 commented Jun 15, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 15, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

codecov bot commented Jun 16, 2024 •

edited

Loading

nidhi-singh02 Jun 17, 2024

coderabbitai bot left a comment

test: add TestGetArrayDimensionality test #1495

test: add TestGetArrayDimensionality test #1495

Conversation

TropicalDog17 commented Jun 15, 2024 • edited by coderabbitai bot Loading

Description

Summary by CodeRabbit

coderabbitai bot commented Jun 15, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Jun 16, 2024 • edited Loading

Codecov Report

nidhi-singh02 Jun 17, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

TropicalDog17 commented Jun 15, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 15, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Jun 16, 2024 •

edited

Loading