Skip to content

Tests/inc coverage#13

Merged
rm-hull merged 14 commits into
mainfrom
tests/inc-coverage
Jun 28, 2025
Merged

Tests/inc coverage#13
rm-hull merged 14 commits into
mainfrom
tests/inc-coverage

Conversation

@rm-hull

@rm-hull rm-hull commented Jun 28, 2025

Copy link
Copy Markdown
Collaborator

No description provided.

rm-hull and others added 10 commits June 27, 2025 21:42
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests on file_operations (#10)
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests on CSV parser (#11)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests on codepoint spatial index (#12)

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Summary of Changes

Hello @rm-hull, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the test coverage for the routes package by introducing a new test file. It focuses on validating the behavior of the CodePointSearch and PolygonSearch handlers under various input conditions, as well as thoroughly testing the utility functions responsible for parsing and validating bounding box parameters.

Highlights

  • New Test File: A new test file, routes/search_test.go, has been introduced to enhance test coverage for the application's routing logic.
  • Route Handler Testing: Comprehensive tests have been added for the CodePointSearch and PolygonSearch handlers, covering various scenarios including invalid bounding box formats, excessively large bounding boxes, and successful search operations.
  • Utility Function Testing: Dedicated unit tests are now in place for the parseBBox and isTooBig helper functions, ensuring the robustness of bounding box parsing and validation logic.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions

github-actions Bot commented Jun 28, 2025

Copy link
Copy Markdown
TestsPassed ✅SkippedFailed
JUnit Test Report33 ran33 passed0 skipped0 failed
TestResult
JUnit Test Report
postcode-polygons/internal.TestDecompressFeatureCollection_Success✅ passed
postcode-polygons/internal.TestDecompressFeatureCollection_FileNotFound✅ passed
postcode-polygons/internal.TestDecompressFeatureCollection_InvalidBZ2✅ passed
postcode-polygons/internal.TestCompressFeatureCollection_Success✅ passed
postcode-polygons/internal.TestCompressFeatureCollection_ErrorOnCreate✅ passed
postcode-polygons/internal.TestCompressFeatureCollection_And_DecompressFeatureCollection_RoundTrip✅ passed
postcode-polygons/routes.TestCodePointSearch_BadBBox✅ passed
postcode-polygons/routes.TestCodePointSearch_TooBig✅ passed
postcode-polygons/routes.TestCodePointSearch_InternalError✅ passed
postcode-polygons/routes.TestCodePointSearch_Success✅ passed
postcode-polygons/routes.TestPolygonSearch_BadBBox✅ passed
postcode-polygons/routes.TestPolygonSearch_InternalError✅ passed
postcode-polygons/routes.TestParseBBox/valid✅ passed
postcode-polygons/routes.TestParseBBox/too_few_parts✅ passed
postcode-polygons/routes.TestParseBBox/not_numbers✅ passed
postcode-polygons/routes.TestParseBBox/min_greater_than_max✅ passed
postcode-polygons/routes.TestParseBBox✅ passed
postcode-polygons/routes.TestIsTooBig/not_too_big✅ passed
postcode-polygons/routes.TestIsTooBig/too_wide✅ passed
postcode-polygons/routes.TestIsTooBig/too_high✅ passed
postcode-polygons/routes.TestIsTooBig✅ passed
postcode-polygons/spatial-index.TestNewCodePointSpatialIndex_Success✅ passed
postcode-polygons/spatial-index.TestNewCodePointSpatialIndex_BadZip✅ passed
postcode-polygons/spatial-index.TestSearch✅ passed
postcode-polygons/spatial-index.TestSearchIter_InvalidBounds✅ passed
postcode-polygons/spatial-index.TestLen✅ passed
postcode-polygons/spatial-index.Test_fromCodePointCSV✅ passed
postcode-polygons/spatial-index.TestParseCSV_WithHeader_Success✅ passed
postcode-polygons/spatial-index.TestParseCSV_WithoutHeader_Success✅ passed
postcode-polygons/spatial-index.TestParseCSV_ParseError✅ passed
postcode-polygons/spatial-index.TestParseCSV_MalformedLine✅ passed
postcode-polygons/spatial-index.TestParseCSV_HeaderReadError✅ passed
postcode-polygons/spatial-index.TestParseCSV_YieldStopsEarly✅ passed

@coveralls

coveralls commented Jun 28, 2025

Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 15948602289

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+14.9%) to 46.983%

Totals Coverage Status
Change from base Build 15948446608: 14.9%
Covered Lines: 218
Relevant Lines: 464

💛 - Coveralls

gemini-code-assist[bot]

This comment was marked as outdated.

rm-hull added 3 commits June 28, 2025 22:42
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Use interface for spatial index rather than concrete struct (#15)
  Inflate the bound box to include polygons whos centroids might be just outside the current bounds (#14)
@rm-hull

rm-hull commented Jun 28, 2025

Copy link
Copy Markdown
Collaborator Author

/gemini review

@rm-hull
rm-hull marked this pull request as ready for review June 28, 2025 22:00

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds a comprehensive set of tests for the search routes, significantly increasing test coverage. The tests cover success paths and various error conditions. My review includes suggestions to improve the tests.

Comment thread routes/search_test.go
Comment on lines +146 to +166
testCases := []struct {
name string
bboxStr string
expectErr bool
}{
{name: "valid", bboxStr: "1,2,3,4", expectErr: false},
{name: "too few parts", bboxStr: "1,2,3", expectErr: true},
{name: "not numbers", bboxStr: "a,b,c,d", expectErr: true},
{name: "min greater than max", bboxStr: "4,3,2,1", expectErr: true},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
_, err := parseBBox(tc.bboxStr)
if tc.expectErr {
require.Error(t, err)
} else {
require.NoError(t, err)
}
})
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

When testing error cases, it's a good practice to assert not just that an error occurred, but also that the error is the one you expect. This makes tests more robust against future changes. I suggest updating the test cases to include the expected error message content and asserting it in the test.

	testCases := []struct {
		name        string
		bboxStr     string
		expectErr   bool
		errContains string
	}{
		{name: "valid", bboxStr: "1,2,3,4", expectErr: false},
		{name: "too few parts", bboxStr: "1,2,3", expectErr: true, errContains: "bbox must have 4 comma-separated values"},
		{name: "not numbers", bboxStr: "a,b,c,d", expectErr: true, errContains: "invalid bbox value"},
		{name: "min greater than max", bboxStr: "4,3,2,1", expectErr: true, errContains: "invalid bbox: min values must be less than or equal to max values"},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			_, err := parseBBox(tc.bboxStr)
			if tc.expectErr {
				require.Error(t, err)
				if tc.errContains != "" {
					require.Contains(t, err.Error(), tc.errContains)
				}
			} else {
				require.NoError(t, err)
			}
		})
	}

@rm-hull
rm-hull merged commit a7fdfc1 into main Jun 28, 2025
3 checks passed
@rm-hull
rm-hull deleted the tests/inc-coverage branch June 28, 2025 22:30
rm-hull added a commit that referenced this pull request Jun 28, 2025
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests over search endpoints (#13)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants