New pinger implementation #222
+334
−114
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /* | ||
| * Copyright (c) 2024 Contributors to the Eclipse Foundation | ||
| * | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * and Eclipse Distribution License v1.0 which accompany this distribution. | ||
| * | ||
| * The Eclipse Public License is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * and the Eclipse Distribution License is available at | ||
| * http://www.eclipse.org/org/documents/edl-v10.php. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause | ||
| */ | ||
|
|
||
| package paho | ||
|
|
||
| import ( | ||
| "net" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/eclipse/paho.golang/packets" | ||
| paholog "github.com/eclipse/paho.golang/paho/log" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestDefaultPingerTimeout(t *testing.T) { | ||
| fakeServerConn, fakeClientConn := net.Pipe() | ||
|
|
||
| go func() { | ||
| // keep reading from fakeServerConn and throw away the data | ||
| buf := make([]byte, 1024) | ||
| for { | ||
| _, err := fakeServerConn.Read(buf) | ||
| if err != nil { | ||
| return | ||
| } | ||
| } | ||
| }() | ||
| defer fakeServerConn.Close() | ||
|
|
||
| pinger := NewDefaultPinger() | ||
| pinger.SetDebug(paholog.NewTestLogger(t, "DefaultPinger:")) | ||
|
|
||
| pingResult := make(chan error, 1) | ||
| go func() { | ||
| pingResult <- pinger.Run(fakeClientConn, 1) | ||
| }() | ||
| defer pinger.Stop() | ||
|
|
||
| select { | ||
| case err := <-pingResult: | ||
| require.NotNil(t, err) | ||
| assert.EqualError(t, err, "PINGRESP timed out") | ||
| case <-time.After(10 * time.Second): | ||
| t.Error("expected DefaultPinger to detect timeout and return error") | ||
| } | ||
| } | ||
|
|
||
| func TestDefaultPingerSuccess(t *testing.T) { | ||
| fakeClientConn, fakeServerConn := net.Pipe() | ||
|
|
||
| pinger := NewDefaultPinger() | ||
| pinger.SetDebug(paholog.NewTestLogger(t, "DefaultPinger:")) | ||
|
|
||
| pingResult := make(chan error, 1) | ||
| go func() { | ||
| pingResult <- pinger.Run(fakeClientConn, 3) | ||
| }() | ||
| defer pinger.Stop() | ||
|
|
||
| go func() { | ||
| // keep reading from fakeServerConn and call PingResp() when a PINGREQ is received | ||
| for { | ||
| recv, err := packets.ReadPacket(fakeServerConn) | ||
| if err != nil { | ||
| return | ||
| } | ||
| if recv.Type == packets.PINGREQ { | ||
| pinger.PingResp() | ||
| } | ||
| } | ||
| }() | ||
| defer fakeServerConn.Close() | ||
|
|
||
| select { | ||
| case err := <-pingResult: | ||
| t.Errorf("expected DefaultPinger to not return error, got %v", err) | ||
| case <-time.After(10 * time.Second): | ||
| // PASS | ||
| } | ||
| } | ||
|
|
||
| func TestDefaultPingerPacketSent(t *testing.T) { | ||
| fakeClientConn, fakeServerConn := net.Pipe() | ||
|
|
||
| pinger := NewDefaultPinger() | ||
| pinger.SetDebug(paholog.NewTestLogger(t, "DefaultPinger:")) | ||
|
|
||
| pingResult := make(chan error, 1) | ||
| go func() { | ||
| pingResult <- pinger.Run(fakeClientConn, 3) | ||
| }() | ||
| defer pinger.Stop() | ||
|
|
||
| // keep calling PacketSent() in a goroutine to check that the Pinger avoids sending PINGREQs when not needed | ||
| stop := make(chan struct{}) | ||
| go func() { | ||
| for { | ||
| select { | ||
| case <-stop: | ||
| return | ||
| default: | ||
| } | ||
| // keep calling PacketSent() | ||
| pinger.PacketSent() | ||
| } | ||
| }() | ||
| defer close(stop) | ||
|
|
||
| // keep reading from fakeServerConn and call PingResp() when a PINGREQ is received | ||
| // if more than one PINGREQ is received, the test will fail | ||
| count := 0 | ||
| tooManyPingreqs := make(chan struct{}) | ||
| go func() { | ||
| for { | ||
| recv, err := packets.ReadPacket(fakeServerConn) | ||
| if err != nil { | ||
| return | ||
| } | ||
| if recv.Type == packets.PINGREQ { | ||
| count++ | ||
| pinger.PingResp() | ||
| if count > 1 { // we allow the count to be 1 because the first PINGREQ is sent immediately | ||
| close(tooManyPingreqs) | ||
| } | ||
| } | ||
| } | ||
| }() | ||
| defer fakeServerConn.Close() | ||
|
|
||
| select { | ||
| case <-tooManyPingreqs: | ||
| t.Error("expected DefaultPinger to not send PINGREQs when not needed") | ||
| case err := <-pingResult: | ||
| t.Errorf("expected DefaultPinger to not return error, got %v", err) | ||
| case <-time.After(10 * time.Second): | ||
| // PASS | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this needed? (it's set but never read; I suspect it was used in a previous iteration?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops. This was supposed to be used to determine whether the client's
SetDebugLogger()should callSetDebug()on the pinger. So right now, thePingers logger will won't be set if the user is relying on the default one. This would be a very small fix, so could be tacked on to some other PR.