Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(tests): Initial panos_zone terraform tests #328

Merged
merged 1 commit into from
Feb 6, 2025
+277 −0
Merged

feat(tests): Initial panos_zone terraform tests #328

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
277 changes: 277 additions & 0 deletions assets/terraform/test/resource_zone_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,277 @@
package provider_test

import (
"context"
"errors"
"fmt"
"strings"
"testing"

sdkErrors "github.com/PaloAltoNetworks/pango/errors"
"github.com/PaloAltoNetworks/pango/network/zone"

"github.com/hashicorp/terraform-plugin-testing/config"
"github.com/hashicorp/terraform-plugin-testing/helper/acctest"
"github.com/hashicorp/terraform-plugin-testing/helper/resource"
"github.com/hashicorp/terraform-plugin-testing/knownvalue"
"github.com/hashicorp/terraform-plugin-testing/statecheck"
"github.com/hashicorp/terraform-plugin-testing/terraform"
"github.com/hashicorp/terraform-plugin-testing/tfjsonpath"
)

func TestAccZone(t *testing.T) {
t.Parallel()

nameSuffix := acctest.RandStringFromCharSet(6, acctest.CharSetAlphaNum)
prefix := fmt.Sprintf("test-acc-%s", nameSuffix)

suffix := "tmpl1"
resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProtoV6ProviderFactories: testAccProviders,
CheckDestroy: testAccZoneDestroy(prefix, fmt.Sprintf("%s-%s", prefix, suffix)),
Steps: []resource.TestStep{
{
Config: zoneResourceTmpl,
ConfigVariables: map[string]config.Variable{
"prefix": config.StringVariable(prefix),
"template_suffix": config.StringVariable(suffix),
"interface_type": config.StringVariable("layer3"),
},
ConfigStateChecks: []statecheck.StateCheck{
statecheck.ExpectKnownValue(
"panos_zone.zone",
tfjsonpath.New("name"),
knownvalue.StringExact(fmt.Sprintf("%s-zone", prefix)),
),
statecheck.ExpectKnownValue(
"panos_zone.zone",
tfjsonpath.New("enable_device_identification"),
knownvalue.Bool(true),
),
statecheck.ExpectKnownValue(
"panos_zone.zone",
tfjsonpath.New("enable_user_identification"),
knownvalue.Bool(true),
),
statecheck.ExpectKnownValue(
"panos_zone.zone",
tfjsonpath.New("network").
AtMapKey("enable_packet_buffer_protection"),
knownvalue.Bool(true),
),
statecheck.ExpectKnownValue(
"panos_zone.zone",
tfjsonpath.New("network").
AtMapKey("layer3"),
knownvalue.ListExact([]knownvalue.Check{
knownvalue.StringExact("ethernet1/1"),
knownvalue.StringExact("ethernet1/2"),
}),
),
},
},
},
})

suffix = "tmpl2"
resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProtoV6ProviderFactories: testAccProviders,
CheckDestroy: testAccZoneDestroy(prefix, fmt.Sprintf("%s-%s", prefix, suffix)),
Steps: []resource.TestStep{
{
Config: zoneResourceTmpl,
ConfigVariables: map[string]config.Variable{
"prefix": config.StringVariable(prefix),
"template_suffix": config.StringVariable(suffix),
"interface_type": config.StringVariable("layer2"),
},
ConfigStateChecks: []statecheck.StateCheck{},
},
},
})

// suffix = "tmpl3"
// resource.Test(t, resource.TestCase{
// PreCheck: func() { testAccPreCheck(t) },
// ProtoV6ProviderFactories: testAccProviders,
// CheckDestroy: testAccZoneDestroy(prefix, fmt.Sprintf("%s-%s", prefix, suffix)),
// Steps: []resource.TestStep{
// {
// Config: zoneResourceTmpl,
// ConfigVariables: map[string]config.Variable{
// "prefix": config.StringVariable(prefix),
// "template_suffix": config.StringVariable(suffix),
// "interface_type": config.StringVariable("external"),
// },
// ConfigStateChecks: []statecheck.StateCheck{},
// },
// },
// })

suffix = "tmpl4"
resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProtoV6ProviderFactories: testAccProviders,
CheckDestroy: testAccZoneDestroy(prefix, fmt.Sprintf("%s-%s", prefix, suffix)),
Steps: []resource.TestStep{
{
Config: zoneResourceTmpl,
ConfigVariables: map[string]config.Variable{
"prefix": config.StringVariable(prefix),
"template_suffix": config.StringVariable(suffix),
"interface_type": config.StringVariable("tap"),
},
ConfigStateChecks: []statecheck.StateCheck{
statecheck.ExpectKnownValue(
"panos_zone.zone",
tfjsonpath.New("network").
AtMapKey("tap"),
knownvalue.ListExact([]knownvalue.Check{
knownvalue.StringExact("ethernet1/1"),
knownvalue.StringExact("ethernet1/2"),
}),
),
},
},
},
})

// suffix = "tmpl5"
// resource.Test(t, resource.TestCase{
// PreCheck: func() { testAccPreCheck(t) },
// ProtoV6ProviderFactories: testAccProviders,
// CheckDestroy: testAccZoneDestroy(prefix, fmt.Sprintf("%s-%s", prefix, suffix)),
// Steps: []resource.TestStep{
// {
// Config: zoneResourceTmpl,
// ConfigVariables: map[string]config.Variable{
// "prefix": config.StringVariable(prefix),
// "template_suffix": config.StringVariable(suffix),
// "interface_type": config.StringVariable("tunnel"),
// },
// ConfigStateChecks: []statecheck.StateCheck{
// statecheck.ExpectKnownValue(
// "panos_zone.zone",
// tfjsonpath.New("network").
// AtMapKey("tunnel"),
// knownvalue.ObjectExact(map[string]knownvalue.Check{}),
// },
// },
// },
// })
}

const zoneResourceTmpl = `
variable "prefix" { type = string }
variable "template_suffix" { type = string }
variable "interface_type" { type = string }

locals {
interfaces = {
layer2 = var.interface_type == "layer2" ? ["ethernet1/1", "ethernet1/2"] : null
layer3 = var.interface_type == "layer3" ? ["ethernet1/1", "ethernet1/2"] : null
external = var.interface_type == "external" ? ["ethernet1/1", "ethernet1/2"] : null
tap = var.interface_type == "tap" ? ["ethernet1/1", "ethernet1/2"] : null
tunnel = var.interface_type == "tunnel" ? {} : null
}

create_iface = contains(["layer2", "layer3", "tap"], var.interface_type) ? true : false

template_name = format("%s-%s", var.prefix, var.template_suffix)
network_common = {
enable_packet_buffer_protection = true
# log_setting = ["log-setting"]
# zone_protection_profile = "zone-protection-profile"
}
network = merge(local.network_common, local.interfaces)
}

resource "panos_template" "template" {
location = { panorama = {} }

name = local.template_name
}


resource "panos_ethernet_interface" "iface1" {
count = local.create_iface == true ? 1 : 0
location = { template = { name = resource.panos_template.template.name, vsys = "vsys1" }}

name = "ethernet1/1"

tap = var.interface_type == "tap" ? {} : null
layer2 = var.interface_type == "layer2" ? {} : null
layer3 = var.interface_type == "layer3" ? {} : null
}

resource "panos_ethernet_interface" "iface2" {
count = local.create_iface == true ? 1 : 0

location = { template = { name = resource.panos_template.template.name, vsys = "vsys1" }}

name = "ethernet1/2"

tap = var.interface_type == "tap" ? {} : null
layer2 = var.interface_type == "layer2" ? {} : null
layer3 = var.interface_type == "layer3" ? {} : null
}

resource "panos_zone" "zone" {
depends_on = [
resource.panos_ethernet_interface.iface1, resource.panos_ethernet_interface.iface2
]

location = { template = { name = resource.panos_template.template.name }}

name = format("%s-zone", var.prefix)

device_acl = {
# exclude_list = ["device-1"]
# include_list = ["device-2"]
}

enable_device_identification = true
enable_user_identification = true

network = local.network
}
`

func testAccZoneDestroy(prefix string, template string) func(s *terraform.State) error {
return func(s *terraform.State) error {
api := zone.NewService(sdkClient)
ctx := context.TODO()

location := zone.NewTemplateLocation()
location.Template = &zone.TemplateLocation{
Template: template,
Vsys: "vsys1",
NgfwDevice: "localhost.localdomain",
PanoramaDevice: "localhost.localdomain",
}

entries, err := api.List(ctx, *location, "get", "", "")
if err != nil && !sdkErrors.IsObjectNotFound(err) {
return fmt.Errorf("error while listing entries via sdk: %v", err)
}

var leftEntries []string
for _, elt := range entries {
if strings.HasPrefix(elt.Name, prefix) {
leftEntries = append(leftEntries, elt.Name)
}
}

if len(leftEntries) > 0 {
err := fmt.Errorf("terraform failed to remove entries from the server")
delErr := api.Delete(ctx, *location, leftEntries...)
if delErr != nil {
return errors.Join(err, delErr)
}
}

return nil
}
}
Loading