[supervisor] add test cases and fix workspace configed ports alway on top

Author: mustard-mh

components/supervisor/pkg/ports/ports-config.go

@@ -16,6 +16,8 @@ import (
 	"github.com/gitpod-io/gitpod/supervisor/pkg/config"
 )
 
+const NON_CONFIGED_BASIC_SCORE = 100000
+
 // RangeConfig is a port range config.
 type RangeConfig struct {
 	gitpod.PortsItems
@@ -190,7 +192,7 @@ func parseWorkspaceConfigs(ports []*gitpod.PortConfig) (portConfigs map[uint32]*
 			portConfigs[port] = &SortConfig{
 				PortConfig: *config,
 				// We don't care about workspace configs but instance config
-				Sort: 0,
+				Sort: NON_CONFIGED_BASIC_SCORE - 1,
 			}
 		}
 	}

components/supervisor/pkg/ports/ports.go

@@ -748,8 +748,8 @@ func (pm *Manager) getStatus() []*api.PortsStatus {
 	}
 	sort.SliceStable(res, func(i, j int) bool {
 		// Max number of port 65536
-		score1 := 100000 + res[i].LocalPort
-		score2 := 100000 + res[j].LocalPort
+		score1 := NON_CONFIGED_BASIC_SCORE + res[i].LocalPort
+		score2 := NON_CONFIGED_BASIC_SCORE + res[j].LocalPort
 		if c, _, ok := pm.configs.Get(res[i].LocalPort); ok {
 			score1 = c.Sort
 		}

components/supervisor/pkg/ports/ports_test.go

@@ -577,6 +577,105 @@ func TestPortsUpdateState(t *testing.T) {
 				},
 			},
 		},
+		{
+			Desc: "change configed ports order with ranged covered not ranged",
+			Changes: []Change{
+				{
+					Config: &ConfigChange{
+						workspace: []*gitpod.PortConfig{
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+						instance: []*gitpod.PortsItems{
+							{Port: 3001, Visibility: "private", Name: "react"},
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+					},
+				},
+				{
+					Config: &ConfigChange{
+						workspace: []*gitpod.PortConfig{
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+						instance: []*gitpod.PortsItems{
+							{Port: 3003, Visibility: "private", Name: "react"},
+							{Port: 3001, Visibility: "private", Name: "react"},
+							{Port: "3001-3005", Visibility: "private", Name: "react"},
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+					},
+				},
+				{
+					Served: []ServedPort{{net.IPv4zero, 3000, false}},
+				},
+				{
+					Served: []ServedPort{{net.IPv4zero, 3000, false}, {net.IPv4zero, 3001, false}, {net.IPv4zero, 3002, false}},
+				},
+				{
+					Config: &ConfigChange{
+						workspace: []*gitpod.PortConfig{
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+						instance: []*gitpod.PortsItems{
+							{Port: 3003, Visibility: "private", Name: "react"},
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+					},
+				},
+				{
+					Config: &ConfigChange{
+						workspace: []*gitpod.PortConfig{
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+						instance: []*gitpod.PortsItems{
+							{Port: "3001-3005", Visibility: "private", Name: "react"},
+							{Port: 3003, Visibility: "private", Name: "react"},
+							{Port: 3000, Visibility: "private", Name: "react"},
+						},
+					},
+				},
+			},
+			ExpectedExposure: []ExposedPort{
+				{LocalPort: 3000},
+				{LocalPort: 3001},
+				{LocalPort: 3002},
+				{LocalPort: 3003},
+			},
+			ExpectedUpdates: UpdateExpectation{
+				{},
+				{
+					{LocalPort: 3001, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3000, Name: "react", OnOpen: api.PortsStatus_notify},
+				},
+				{
+					{LocalPort: 3003, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3001, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3000, Name: "react", OnOpen: api.PortsStatus_notify},
+				},
+				{
+					{LocalPort: 3003, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3001, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3000, Served: true, Name: "react", OnOpen: api.PortsStatus_notify},
+				},
+				{
+					{LocalPort: 3003, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3001, Served: true, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3002, Served: true, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3000, Served: true, Name: "react", OnOpen: api.PortsStatus_notify},
+				},
+				{
+					{LocalPort: 3003, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3000, Served: true, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3001, Served: true, OnOpen: api.PortsStatus_notify_private},
+					{LocalPort: 3002, Served: true, OnOpen: api.PortsStatus_notify_private},
+				},
+				{
+					{LocalPort: 3001, Name: "react", Served: true, OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3002, Name: "react", Served: true, OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3003, Name: "react", OnOpen: api.PortsStatus_notify},
+					{LocalPort: 3000, Served: true, Name: "react", OnOpen: api.PortsStatus_notify},
+				},
+			},
+		},
 	}
 
 	log.Log.Logger.SetLevel(logrus.FatalLevel)