-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[backport] feat(riseupvpn): include bootstrap in progress
This diff backports #1364 to the release/3.19 branch. This diff modifies riseupvpn to include bootstrap in progress. We define as riseupvpn's bootstrap the process of fetching the CA and the various JSON files needed to find out the gateways to measure. I previously stopped including bootstrap in progress in #1363, which I did because the progress was not monotonic. This diff introduces helpers that make it very obvious to emit monotonic bootstrap through the ./internal/progress package. This work is part of ooni/probe#1432.
- Loading branch information
1 parent
3989fd4
commit a1b7f60
Showing
3 changed files
with
141 additions
and
10 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // Package progress contains utilities to emit progress. | ||
| package progress | ||
|
|
||
| import ( | ||
| "github.com/ooni/probe-cli/v3/internal/model" | ||
| "github.com/ooni/probe-cli/v3/internal/runtimex" | ||
| ) | ||
|
|
||
| // Scaler implements [model.ExperimentCallbacks] and scales progress | ||
| // as instructed through the [NewScaler] constructor. | ||
| // | ||
| // The [*Scaler] is safe to use from multiple goroutine contexts. | ||
| type Scaler struct { | ||
| cbs model.ExperimentCallbacks | ||
| offset float64 | ||
| total float64 | ||
| } | ||
|
|
||
| // NewScaler constructs a new [*Scaler] using the given offset and total | ||
| // and emitting progress using the given [model.ExperimentCallbacks]. | ||
| // | ||
| // The offset is added to each progress value we emit. The total is | ||
| // used to scale the 100% to a suitable subset. | ||
| // | ||
| // For example, with offset equal to 0.1 and total equal to 0.5, the value | ||
| // 0.5 corresponds to 0.3 and the value 1 (i.e., 100%) is 0.5. | ||
| // | ||
| // This func PANICS if offset<0, offset >= total, total<=0, total>1. | ||
| func NewScaler(callbacks model.ExperimentCallbacks, offset, total float64) *Scaler { | ||
| runtimex.Assert(offset >= 0.0 && offset < total, "NewScaler: offset must be >= 0 and < total") | ||
| runtimex.Assert(total > 0.0 && total <= 1, "NewScaler: total must be > 0 and <= 1") | ||
| return &Scaler{ | ||
| cbs: callbacks, | ||
| offset: offset, | ||
| total: total, | ||
| } | ||
| } | ||
|
|
||
| var _ model.ExperimentCallbacks = &Scaler{} | ||
|
|
||
| // OnProgress implements model.ExperimentCallbacks. | ||
| func (s *Scaler) OnProgress(percentage float64, message string) { | ||
| s.cbs.OnProgress(s.offset+percentage*(s.total-s.offset), message) | ||
| } |
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,87 @@ | ||
| package progress | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| "github.com/google/go-cmp/cmp/cmpopts" | ||
| "github.com/ooni/probe-cli/v3/internal/model" | ||
| ) | ||
|
|
||
| type capturerCallbacks struct { | ||
| value float64 | ||
| } | ||
|
|
||
| var _ model.ExperimentCallbacks = &capturerCallbacks{} | ||
|
|
||
| // OnProgress implements model.ExperimentCallbacks. | ||
| func (v *capturerCallbacks) OnProgress(percentage float64, message string) { | ||
| v.value = percentage | ||
| } | ||
|
|
||
| func TestScaler(t *testing.T) { | ||
| // testcase is a test case run by this function. | ||
| type testcase struct { | ||
| // name is the test case name. | ||
| name string | ||
|
|
||
| // offset is the offset (>=0, <total) | ||
| offset float64 | ||
|
|
||
| // total is the total (>0, <=1) | ||
| total float64 | ||
|
|
||
| // emit is the list of progress values to emit. | ||
| emit []float64 | ||
|
|
||
| // expect is the list of progress values we expect in output. | ||
| expect []float64 | ||
| } | ||
|
|
||
| cases := []testcase{{ | ||
| name: "with offset==0 and total=1", | ||
| offset: 0, | ||
| total: 1, | ||
| emit: []float64{0, 0.2, 0.4, 0.6, 0.8, 1}, | ||
| expect: []float64{0, 0.2, 0.4, 0.6, 0.8, 1}, | ||
| }, { | ||
| name: "with offset==0 and total=0.5", | ||
| offset: 0, | ||
| total: 0.5, | ||
| emit: []float64{0, 0.2, 0.4, 0.6, 0.8, 1}, | ||
| expect: []float64{0, 0.1, 0.2, 0.3, 0.4, 0.5}, | ||
| }, { | ||
| name: "with offset==0.5 and total=1", | ||
| offset: 0.5, | ||
| total: 1, | ||
| emit: []float64{0, 0.2, 0.4, 0.6, 0.8, 1}, | ||
| expect: []float64{0.5, 0.6, 0.7, 0.8, 0.9, 1}, | ||
| }, { | ||
| name: "with offset==0.2 and total=0.7", | ||
| offset: 0.2, | ||
| total: 0.7, | ||
| emit: []float64{0, 0.2, 0.4, 0.6, 0.8, 1}, | ||
| expect: []float64{0.2, 0.3, 0.4, 0.5, 0.6, 0.7}, | ||
| }, { | ||
| name: "with offset=0.4 and total=0.5", | ||
| offset: 0.4, | ||
| total: 0.5, | ||
| emit: []float64{0, 0.2, 0.4, 0.6, 0.8, 1}, | ||
| expect: []float64{0.4, 0.42, 0.44, 0.46, 0.48, 0.5}, | ||
| }} | ||
|
|
||
| for _, tc := range cases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| var got []float64 | ||
| for _, v := range tc.emit { | ||
| cc := &capturerCallbacks{} | ||
| wrapper := NewScaler(cc, tc.offset, tc.total) | ||
| wrapper.OnProgress(v, "") | ||
| got = append(got, cc.value) | ||
| } | ||
| if diff := cmp.Diff(tc.expect, got, cmpopts.EquateApprox(0, 0.01)); diff != "" { | ||
| t.Fatal(diff) | ||
| } | ||
| }) | ||
| } | ||
| } |