Skip to content

OCM-17408 | fix: handle non error status code with EOF to not return an error #240

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.

Sign up for GitHub

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

Merged
openshift-merge-bot merged 3 commits into from
Jul 29, 2025
Merged

OCM-17408 | fix: handle non error status code with EOF to not return an error #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf8e1c7
OCM-17408 | fix: handle non error status code with EOF to not return …
etabak Jul 28, 2025
7fdf6cf
Remove redundant comments
etabak Jul 29, 2025
a5ae4ee
Remove more redundant comments
etabak Jul 29, 2025
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
8 changes: 8 additions & 0 deletions pkg/generators/golang/clients_generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,10 @@ func (g *ClientsGenerator) generateVersionMetadataClientSource(version *concepts
reader := bufio.NewReader(response.Body)
_, err = reader.Peek(1)
if err == io.EOF {
if result.status >= 200 && result.status < 300 {
// For success status codes with empty body, return no error
err = nil
}
return
}
if result.status >= 400 {
Expand Down Expand Up @@ -880,6 +884,10 @@ func (g *ClientsGenerator) generateRequestSource(method *concepts.Method) {
reader := bufio.NewReader(response.Body)
_, err = reader.Peek(1)
if err == io.EOF {
if result.status >= 200 && result.status < 300 {
// For success status codes with empty body, return no error
err = nil
}
return
}
if result.status >= 400 {
Expand Down
64 changes: 19 additions & 45 deletions tests/go/clients_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ var _ = Describe("Client", func() {
})

It("Can execute action with one input parameter", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand Down Expand Up @@ -149,14 +148,12 @@ var _ = Describe("Client", func() {
),
)

// Prepare the description of the cluster:
cluster, err := cmv1.NewCluster().
Name("mycluster").
ExternalID("456").
Build()
Expect(err).ToNot(HaveOccurred())

// Send the request:
client := cmv1.NewClient(transport, "/api/clusters_mgmt/v1")
response, err := client.RegisterDisconnected().
Cluster(cluster).
Expand All @@ -173,7 +170,6 @@ var _ = Describe("Client", func() {
})

It("Can execute action with multiple input parameters", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -197,7 +193,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClient(transport, "/api/clusters_mgmt/v1")
response, err := client.RegisterCluster().
SubscriptionID("123").
Expand All @@ -215,7 +210,6 @@ var _ = Describe("Client", func() {
})

It("Can retrieve nil list", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -226,19 +220,16 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.List().Send()
Expect(err).ToNot(HaveOccurred())
Expect(response).ToNot(BeNil())

// Verify the result:
items := response.Items()
Expect(items).To(BeNil())
})

It("Can retrieve empty list", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -254,7 +245,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.List().Send()
Expect(err).ToNot(HaveOccurred())
Expand All @@ -267,7 +257,6 @@ var _ = Describe("Client", func() {
})

It("Can retrieve list with one element", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -288,7 +277,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.List().Send()
Expect(err).ToNot(HaveOccurred())
Expand All @@ -308,7 +296,6 @@ var _ = Describe("Client", func() {
})

It("Can retrieve list with two elements", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -333,7 +320,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.List().Send()
Expect(err).ToNot(HaveOccurred())
Expand All @@ -357,7 +343,6 @@ var _ = Describe("Client", func() {
})

It("Sends paging parameters", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -370,7 +355,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.List().
Page(123).
Expand All @@ -381,7 +365,6 @@ var _ = Describe("Client", func() {
})

It("Can retrieve paging parameters", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -400,7 +383,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.List().Send()
Expect(err).ToNot(HaveOccurred())
Expand All @@ -415,15 +397,13 @@ var _ = Describe("Client", func() {
DescribeTable(
"Custom query parameters",
func(value interface{}, expected string) {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyFormKV("my", expected),
RespondWith(http.StatusOK, `{}`),
),
)

// Send the request:
client := cmv1.NewClusterClient(transport, "")
_, err := client.Get().Parameter("my", value).Send()
Expect(err).ToNot(HaveOccurred())
Expand All @@ -447,7 +427,6 @@ var _ = Describe("Client", func() {
)

It("Returns error with HTTP status code", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -467,7 +446,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClusterClient(transport, "/api/clusters_mgmt/v1/clusters/123")
_, err := client.Delete().Send()
Expect(err).To(HaveOccurred())
Expand All @@ -480,7 +458,6 @@ var _ = Describe("Client", func() {
})

It("Sends date parameter in RFC3339 format", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -492,7 +469,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := sbv1.NewStatusesClient(transport, "/api/status_board/v1/statuses")
date, err := time.Parse(time.RFC3339, "2022-01-25T15:57:02+01:00")
Expect(err).ToNot(HaveOccurred())
Expand All @@ -504,7 +480,6 @@ var _ = Describe("Client", func() {
})

It("Accepts `204 No Content` with empty response body", func() {
// Prepare the server:
server.AppendHandlers(
RespondWith(http.StatusNoContent, ""),
)
Expand All @@ -514,7 +489,6 @@ var _ = Describe("Client", func() {
wrapped: transport,
}

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
body, err := cmv1.NewCluster().
Name("my-cluster").
Expand All @@ -523,51 +497,57 @@ var _ = Describe("Client", func() {
response, err := client.Add().
Body(body).
Send()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("EOF"))
Expect(err).ToNot(HaveOccurred())
Expect(response).ToNot(BeNil())
Expect(response.Status()).To(Equal(http.StatusNoContent))
Expect(response.Body()).To(BeNil())
})

It("Returns EOF error when response body is empty for successful request", func() {
// Prepare the server to return a successful status with no content:
It("Returns no error when response body is empty for successful request", func() {
server.AppendHandlers(
RespondWith(http.StatusOK, ""),
)

// Create a transport that replaces the response body with an empty reader:
transport = &EmptyResponseBodyTransport{
wrapped: transport,
}
response, err := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters").List().Send()

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.List().Send()
Expect(err).ToNot(HaveOccurred())
Expect(response).ToNot(BeNil())
Expect(response.Status()).To(Equal(http.StatusOK))
})

// With the change, EOF error should be preserved instead of being set to nil
It("Returns EOF error when response body is empty for error status", func() {
server.AppendHandlers(
RespondWith(http.StatusBadRequest, ""),
)
// Create a transport that replaces the response body with an empty reader:
transport = &EmptyResponseBodyTransport{
wrapped: transport,
}
response, err := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters").List().Send()

// For error status codes with empty body, EOF error should be returned
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("EOF"))
Expect(response).ToNot(BeNil())
Expect(response.Status()).To(Equal(http.StatusOK))
Expect(response.Status()).To(Equal(http.StatusBadRequest))
})

It("Honors @http in query parameter", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyFormKV("dryRun", "true"),
RespondWith(http.StatusOK, `{}`),
),
)

// Prepare the body:
body, err := cmv1.NewCluster().
Name("my").
Build()
Expect(err).ToNot(HaveOccurred())

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.Add().
DryRun(true).
Expand All @@ -578,7 +558,6 @@ var _ = Describe("Client", func() {
})

It("Honors @http in path segment", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyRequest(
Expand All @@ -589,15 +568,13 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.TestAnnotations().Send()
Expect(err).ToNot(HaveOccurred())
Expect(response).ToNot(BeNil())
})

It("Honors @json and ignores @http in request body parameter", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
VerifyJSON(`{
Expand All @@ -607,7 +584,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.TestAnnotations().
My(true).
Expand All @@ -617,7 +593,6 @@ var _ = Describe("Client", func() {
})

It("Honors @json and ignores @http in response body parameter", func() {
// Prepare the server:
server.AppendHandlers(
CombineHandlers(
RespondWith(http.StatusOK, `{
Expand All @@ -626,7 +601,6 @@ var _ = Describe("Client", func() {
),
)

// Send the request:
client := cmv1.NewClustersClient(transport, "/api/clusters_mgmt/v1/clusters")
response, err := client.TestAnnotations().
My(true).
Expand Down
Loading