util: Move Gateways field to FrequencyPlanDescription

Author: halimi

pkg/frequencyplans/frequencyplans.go

@@ -346,8 +346,6 @@ type FrequencyPlan struct {
 	DefaultRx2DataRate *uint8   `yaml:"rx2-default-data-rate,omitempty"`
 	// MaxEIRP is the maximum EIRP as ceiling for any (sub-)band value.
 	MaxEIRP *float32 `yaml:"max-eirp,omitempty"`
-	// Gateways is a boolean indicating whether the frequency plan is suitable for gateways.
-	Gateways *bool `yaml:"gateways,omitempty"`
 }
 
 // Extend returns the same frequency plan, with values overridden by the passed frequency plan.
@@ -414,10 +412,6 @@ func (fp FrequencyPlan) Extend(extension FrequencyPlan) FrequencyPlan {
 		val := *extension.MaxEIRP
 		extended.MaxEIRP = &val
 	}
-	if extension.Gateways != nil {
-		val := *extension.Gateways
-		extended.Gateways = &val
-	}
 
 	return extended
 }
@@ -534,6 +528,8 @@ type FrequencyPlanDescription struct {
 	BaseFrequency uint16 `yaml:"base-frequency"`
 	// File is the file where the frequency plan is defined.
 	File string `yaml:"file"`
+	// Gateways is a boolean indicating whether the frequency plan is suitable for gateways.
+	Gateways *bool `yaml:"gateways,omitempty"`
 }
 
 var errFetchFailed = errors.Define("fetch", "fetching failed")
@@ -735,28 +731,3 @@ func (s *Store) GetAllIDs() ([]string, error) {
 
 	return ids, nil
 }
-
-// GetGatewayFrequencyPlans returns the list of frequency plans that are suitable for gateways.
-func (s *Store) GetGatewayFrequencyPlans() ([]*FrequencyPlan, error) {
-	if s == nil {
-		return nil, errNotConfigured.New()
-	}
-
-	descriptions, err := s.descriptions()
-	if err != nil {
-		return nil, errReadList.WithCause(err)
-	}
-
-	var gatewayFrequencyPlans []*FrequencyPlan
-	for _, description := range descriptions {
-		frequencyPlan, err := s.getByID(description.ID)
-		if err != nil {
-			return nil, err
-		}
-		if frequencyPlan.Gateways != nil && *frequencyPlan.Gateways {
-			gatewayFrequencyPlans = append(gatewayFrequencyPlans, frequencyPlan)
-		}
-	}
-
-	return gatewayFrequencyPlans, nil
-}

pkg/frequencyplans/frequencyplans_test.go

@@ -88,16 +88,19 @@ func TestStore(t *testing.T) {
   description: South East Asia
   base-frequency: 915
   file: AS_923.yml
+  gateways: true
 - id: JP
   base-id: AS_923
   description: Japan
   base-frequency: 915
   file: JP.yml
+  gateways: true
 - id: KR
   base-id: AS_923
   description: South Korea
   base-frequency: 915
   file: KR.yml
+  gateways: true
 - id: EU_863_870
   description: European Union
   file: EU.yml
@@ -106,16 +109,19 @@ func TestStore(t *testing.T) {
   description: United States
   file: US_915.yml
   base-frequency: 915
+  gateways: true
 - id: SA
   base-id: AFRICA
   description: South Africa
   file: AS_923.yml
   base-frequency: 868
+  gateways: false
 - id: CA
   base-id: US_915
   description: Canada
   file: EU.yml
   base-frequency: 915
+  gateways: false
 `),
 		"AS_923.yml": []byte(`band-id: AS_923
 uplink-channels:
@@ -486,71 +492,3 @@ dwell-time:
 		})
 	}
 }
-
-func TestGetGatewayFrequencyPlans(t *testing.T) {
-	t.Parallel()
-	a := assertions.New(t)
-
-	store := frequencyplans.NewStore(fetch.NewMemFetcher(map[string][]byte{
-		"frequency-plans.yml": []byte(`- id: EU_863_870
-  band-id: EU_863_870
-  name: Europe 863-870 MHz (SF12 for RX2)
-  description: Default frequency plan for Europe
-  base-frequency: 868
-  file: EU_863_870.yml
-- id: EU_863_870_TTN
-  band-id: EU_863_870
-  name: Europe 863-870 MHz (SF9 for RX2 - recommended)
-  description: TTN Community Network frequency plan for Europe, using SF9 for RX2
-  base-frequency: 868
-  base-id: EU_863_870
-  file: EU_863_870_TTN.yml
-- id: US_902_928_FSB_1
-  band-id: US_902_928
-  name: United States 902-928 MHz, FSB 1
-  description: Default frequency plan for the United States and Canada, using sub-band 1
-  base-frequency: 915
-  file: US_902_928_FSB_1.yml
-- id: AS_923_2
-  band-id: AS_923_2
-  name: Asia 920-923 MHz (AS923 Group 2) with only default channels
-  description: Compatibility frequency plan for Asian countries with common channels in the 921.4-922.0 MHz sub-band
-  base-frequency: 915
-  file: AS_923_2.yml
-- id: AS_923_2_DT
-  band-id: AS_923_2
-  name: Asia 920-923 MHz (AS923 Group 2) with only default channels and dwell time enabled
-  base-frequency: 915
-  base-id: AS_923_2
-  file: enable_dwell_time_400ms.yml
-`),
-		"EU_863_870.yml": []byte(`band-id: EU_863_870
-max-eirp: 1
-gateways: false
-`),
-		"EU_863_870_TTN.yml": []byte(`max-eirp: 2
-gateways: true
-`),
-		"US_902_928_FSB_1.yml": []byte(`band-id: US_902_928
-max-eirp: 3
-`),
-		"AS_923_2.yml": []byte(`band-id: AS_923_2
-max-eirp: 4
-gateways: true
-`),
-		"enable_dwell_time_400ms.yml": []byte(`max-eirp: 5
-gateways: false
-`),
-	}))
-
-	// Frequency plan with gateways
-	{
-		plans, err := store.GetGatewayFrequencyPlans()
-		a.So(err, should.BeNil)
-		a.So(plans, should.HaveLength, 2)
-		a.So(plans[0].BandID, should.Equal, "EU_863_870")
-		a.So(plans[1].BandID, should.Equal, "AS_923_2")
-		a.So(*plans[0].MaxEIRP, should.Equal, 2)
-		a.So(*plans[1].MaxEIRP, should.Equal, 4)
-	}
-}

pkg/frequencyplans/rpc.go

@@ -42,14 +42,8 @@ func (s *RPCServer) ListFrequencyPlans(ctx context.Context, req *ttnpb.ListFrequ
 		if req.BandId != "" && req.BandId != desc.BandID {
 			continue
 		}
-		if req.GatewaysOnly {
-			frequencyPlan, err := s.store.getByID(desc.ID)
-			if err != nil {
-				return nil, err
-			}
-			if frequencyPlan.Gateways == nil || !*frequencyPlan.Gateways {
-				continue
-			}
+		if req.GatewaysOnly && (desc.Gateways == nil || !*desc.Gateways) {
+			continue
 		}
 		res.FrequencyPlans = append(res.FrequencyPlans, &ttnpb.FrequencyPlanDescription{
 			Id:            desc.ID,

pkg/frequencyplans/rpc_test.go

@@ -35,26 +35,18 @@ func TestRPCServer(t *testing.T) {
   description: Frequency Plan A
   base-frequency: 868
   file: A.yml
+  gateways: true
 - id: B
   band-id: AS_923
   base-id: A
   description: Frequency Plan B
   file: B.yml
+  gateways: false
 - id: C
   band-id: US_902_928
   description: Frequency Plan C
   base-frequency: 915
   file: C.yml`),
-		"A.yml": []byte(`band-id: EU_863_870
-max-eirp: 1
-gateways: false
-`),
-		"B.yml": []byte(`max-eirp: 2
-gateways: true
-`),
-		"C.yml": []byte(`band-id: US_902_928
-max-eirp: 3
-`),
 	}))
 
 	server := frequencyplans.NewRPCServer(store)
@@ -102,5 +94,5 @@ max-eirp: 3
 	})
 	a.So(err, should.BeNil)
 	a.So(gateways.FrequencyPlans, should.HaveLength, 1)
-	a.So(bandAS.FrequencyPlans[0], should.Resemble, expectedAll[1])
+	a.So(gateways.FrequencyPlans[0], should.Resemble, expectedAll[0])
 }