[supervisor] add test cases for ports order

Author: mustard-mh

components/supervisor/pkg/ports/ports_test.go

@@ -12,14 +12,13 @@ import (
 	"testing"
 	"time"
 
+	"github.com/gitpod-io/gitpod/common-go/log"
+	gitpod "github.com/gitpod-io/gitpod/gitpod-protocol"
+	"github.com/gitpod-io/gitpod/supervisor/api"
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/sync/errgroup"
-
-	"github.com/gitpod-io/gitpod/common-go/log"
-	gitpod "github.com/gitpod-io/gitpod/gitpod-protocol"
-	"github.com/gitpod-io/gitpod/supervisor/api"
 )
 
 func TestPortsUpdateState(t *testing.T) {
@@ -556,7 +555,7 @@ func TestPortsUpdateState(t *testing.T) {
 				for _, c := range test.Changes {
 					if c.Config != nil {
 						change := &Configs{}
-						change.workspaceConfigs = parseWorkspaceConfigs(c.Config.workspace)
+						change.workspaceConfigs, change.workspaceConfigsOrder = parseWorkspaceConfigs(c.Config.workspace)
 						portConfigs, rangeConfigs := parseInstanceConfigs(c.Config.instance)
 						change.instancePortConfigs = portConfigs
 						change.instanceRangeConfigs = rangeConfigs
@@ -746,3 +745,95 @@ func TestPortsConcurrentSubscribe(t *testing.T) {
 
 	wg.Wait()
 }
+
+func TestManager_getStatus(t *testing.T) {
+	type fields struct {
+		orderInYaml []uint32
+		state       map[uint32]bool
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   []uint32
+	}{
+		{
+			name: "happy path",
+			fields: fields{
+				orderInYaml: []uint32{1002, 1000, 1001},
+				state: map[uint32]bool{
+					1000: true,
+					1001: true,
+					1002: true,
+					4002: true,
+					4000: true,
+					5000: false,
+					5005: true,
+				},
+			},
+			want: []uint32{1002, 1000, 1001, 4000, 4002, 5005},
+		},
+		{
+			name: "ignore ports that not served and not exists in yaml",
+			fields: fields{
+				orderInYaml: []uint32{1002, 1000, 1001},
+				state: map[uint32]bool{
+					1000: true,
+					1001: true,
+					1002: true,
+					4000: false,
+				},
+			},
+			want: []uint32{1002, 1000, 1001},
+		},
+		{
+			name: "not ignore ports that not served but exists in yaml",
+			fields: fields{
+				orderInYaml: []uint32{1002, 1000, 1001},
+				state:       map[uint32]bool{1002: false, 1000: false, 1001: false},
+			},
+			want: []uint32{1002, 1000, 1001},
+		},
+		{
+			name: "served ports order by number ASC",
+			fields: fields{
+				orderInYaml: []uint32{},
+				state: map[uint32]bool{
+					4000: true,
+					4003: true,
+					4007: true,
+					4001: true,
+					4006: false,
+				},
+			},
+			want: []uint32{4000, 4001, 4003, 4007},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			state := make(map[uint32]*managedPort)
+			for port, served := range tt.fields.state {
+				state[port] = &managedPort{
+					Served:             served,
+					LocalhostPort:      port,
+					TunneledTargetPort: port,
+					TunneledClients:    map[string]uint32{},
+				}
+			}
+			pm := &Manager{
+				configs: &Configs{
+					workspaceConfigsOrder: tt.fields.orderInYaml,
+				},
+				state: state,
+			}
+			got := pm.getStatus()
+			if len(got) != len(tt.want) {
+				t.Errorf("Manager.getStatus() length = %v, want %v", len(got), len(tt.want))
+			}
+			for i := 0; i < len(got); i++ {
+				if got[i].LocalPort != tt.want[i] {
+					t.Errorf("Manager.getStatus() %v, want %v", got, tt.want)
+				}
+			}
+		})
+	}
+}