feat: Add cloudstack_network data source and associated tests

Author: ianc769

cloudstack/data_source_cloudstack_network.go

@@ -0,0 +1,280 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+package cloudstack
+
+import (
+	"encoding/json"
+	"fmt"
+	"log"
+	"regexp"
+	"strings"
+
+	"github.com/apache/cloudstack-go/v2/cloudstack"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func dataSourceCloudstackNetwork() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceCloudstackNetworkRead,
+		Schema: map[string]*schema.Schema{
+			"filter": dataSourceFiltersSchema(),
+
+			"zone_id": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+
+			"project_id": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+
+			"vpc_id": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+
+			// Computed values
+			"name": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"display_text": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"cidr": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"gateway": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"netmask": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"vlan": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"network_offering_id": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"network_offering_name": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"network_domain": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"acl_id": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"acl_name": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"zone_name": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"project": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"vpc_name": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"state": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"type": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"traffic_type": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+
+			"is_default": {
+				Type:     schema.TypeBool,
+				Computed: true,
+			},
+
+			"is_persistent": {
+				Type:     schema.TypeBool,
+				Computed: true,
+			},
+
+			"tags": tagsSchema(),
+		},
+	}
+}
+
+func dataSourceCloudstackNetworkRead(d *schema.ResourceData, meta interface{}) error {
+	cs := meta.(*cloudstack.CloudStackClient)
+	p := cs.Network.NewListNetworksParams()
+
+	// Set optional filters
+	if zoneID, ok := d.GetOk("zone_id"); ok {
+		p.SetZoneid(zoneID.(string))
+	}
+
+	if projectID, ok := d.GetOk("project_id"); ok {
+		p.SetProjectid(projectID.(string))
+	}
+
+	if vpcID, ok := d.GetOk("vpc_id"); ok {
+		p.SetVpcid(vpcID.(string))
+	}
+
+	// List all networks
+	csNetworks, err := cs.Network.ListNetworks(p)
+	if err != nil {
+		return fmt.Errorf("Failed to list networks: %s", err)
+	}
+
+	filters := d.Get("filter")
+	var networks []*cloudstack.Network
+
+	for _, n := range csNetworks.Networks {
+		match, err := applyNetworkFilters(n, filters.(*schema.Set))
+		if err != nil {
+			return err
+		}
+		if match {
+			networks = append(networks, n)
+		}
+	}
+
+	if len(networks) == 0 {
+		return fmt.Errorf("No network matching the specified filters")
+	}
+
+	if len(networks) > 1 {
+		return fmt.Errorf("More than one network found matching the specified filters. Please refine your filters to match a single network")
+	}
+
+	network := networks[0]
+	log.Printf("[DEBUG] Selected network: %s\n", network.Name)
+
+	return networkDescriptionAttributes(d, network)
+}
+
+func networkDescriptionAttributes(d *schema.ResourceData, network *cloudstack.Network) error {
+	d.SetId(network.Id)
+	d.Set("name", network.Name)
+	d.Set("display_text", network.Displaytext)
+	d.Set("cidr", network.Cidr)
+	d.Set("gateway", network.Gateway)
+	d.Set("netmask", network.Netmask)
+	d.Set("vlan", network.Vlan)
+	d.Set("network_offering_id", network.Networkofferingid)
+	d.Set("network_offering_name", network.Networkofferingname)
+	d.Set("network_domain", network.Networkdomain)
+	d.Set("acl_id", network.Aclid)
+	d.Set("acl_name", network.Aclname)
+	d.Set("zone_id", network.Zoneid)
+	d.Set("zone_name", network.Zonename)
+	d.Set("project", network.Project)
+	d.Set("project_id", network.Projectid)
+	d.Set("vpc_id", network.Vpcid)
+	d.Set("vpc_name", network.Vpcname)
+	d.Set("state", network.State)
+	d.Set("type", network.Type)
+	d.Set("traffic_type", network.Traffictype)
+	d.Set("is_default", network.Isdefault)
+	d.Set("is_persistent", network.Ispersistent)
+	d.Set("tags", tagsToMap(network.Tags))
+
+	return nil
+}
+
+func applyNetworkFilters(network *cloudstack.Network, filters *schema.Set) (bool, error) {
+	var networkJSON map[string]interface{}
+	k, _ := json.Marshal(network)
+	err := json.Unmarshal(k, &networkJSON)
+	if err != nil {
+		return false, err
+	}
+
+	for _, f := range filters.List() {
+		m := f.(map[string]interface{})
+		log.Printf("[DEBUG] Applying filter: %v", m)
+
+		r, err := regexp.Compile(m["value"].(string))
+		if err != nil {
+			return false, fmt.Errorf("Invalid regex: %s", err)
+		}
+
+		updatedName := strings.ReplaceAll(m["name"].(string), "_", "")
+
+		// Check if the field exists in the JSON
+		networkField, ok := networkJSON[updatedName]
+		if !ok {
+			log.Printf("[DEBUG] Field %s not found in network", updatedName)
+			return false, nil
+		}
+
+		// Handle different field types
+		var fieldValue string
+		switch v := networkField.(type) {
+		case string:
+			fieldValue = v
+		case bool:
+			fieldValue = fmt.Sprintf("%t", v)
+		case float64:
+			fieldValue = fmt.Sprintf("%v", v)
+		default:
+			log.Printf("[DEBUG] Unsupported field type for %s", updatedName)
+			return false, nil
+		}
+
+		if !r.MatchString(fieldValue) {
+			return false, nil
+		}
+	}
+
+	return true, nil
+}