port to v2 sdk (#969)

Changes that were required to upgrade the SDK:

* DNS hosts is now a set and it is read from libvirt into the state
* DCHP enablement is now computed, and uses a workaround to be explicitly set or disabled by the user while being enabled by default, unfortunately, using `GetOkExists` for now
* cloudinit disks are read back, and a workaround (custom serial) is used to mark them as owned by the cloudinit setting. This workaround needs to be improved/cleaned up.
* Ignition provider uses the old v1 SDK and [my contribution to update it to v2](community-terraform-providers/terraform-provider-ignition#15) has not been merged, therefore our tests refer to [my upgraded fork](https://github.com/dmacvicar/terraform-provider-ignition).
* Some settings are now read back from libvirt, like firmware, nvram, cpu mode, etc.

Future work could be to port the Create/Read/etc functions to their new equivalents, which have better support for Context and Diagnostics.

Author: dmacvicar

.github/workflows/test.yml

@@ -17,8 +17,14 @@ jobs:
   lint:
     name: Lint
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: ["1.18.x"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 2
       - name: terraform fmt
@@ -28,20 +34,21 @@ jobs:
         uses: golangci/golangci-lint-action@v3
         with:
           version: v1.48.0
+          go-version: ${{ matrix.go-version }}
           only-new-issues: true
   build:
     name: Build
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         include:
-          - {os: ubuntu-latest, go: 1.16}
-          - {os: windows-latest, go: 1.16}
-          - {os: macos-latest, go: 1.16}
+          - {os: ubuntu-latest, go: 1.18}
+          - {os: windows-latest, go: 1.18}
+          - {os: macos-latest, go: 1.18}
     timeout-minutes: 10
     steps:
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go }}
         id: go

.golangci.yaml

@@ -24,5 +24,14 @@ linters:
     - errorlint
     - errcheck
     - gomnd
+
 issues:
   new-from-rev: HEAD~
+  exclude-rules:
+    - text: "Error return value of `d.Set` is not checked"
+      linters:
+        - errcheck
+    - text: "Magic number: 1024, in <argument> detected"
+      linters:
+        - gomnd
+

go.mod

@@ -2,22 +2,19 @@ module github.com/dmacvicar/terraform-provider-libvirt
 
 require (
 	github.com/c4milo/gotoolkit v0.0.0-20170704181456-e37eeabad07e // indirect
-	github.com/coreos/go-semver v0.3.0 // indirect
+	github.com/community-terraform-providers/terraform-provider-ignition/v2 v2.1.2
 	github.com/davecgh/go-spew v1.1.1
 	github.com/digitalocean/go-libvirt v0.0.0-20220616141158-7ed4ed4decd9
-	github.com/fatih/color v1.10.0 // indirect
 	github.com/google/uuid v1.1.2
-	github.com/hashicorp/go-getter v1.6.2 // indirect
-	github.com/hashicorp/terraform-plugin-sdk v1.9.0
+	github.com/hashicorp/terraform-plugin-sdk/v2 v2.21.0
 	github.com/hooklift/assert v0.0.0-20170704181755-9d1defd6d214 // indirect
 	github.com/hooklift/iso9660 v1.0.0
 	github.com/mattn/goveralls v0.0.2
 	github.com/pborman/uuid v1.2.0 // indirect
-	github.com/stretchr/testify v1.7.0
-	github.com/terraform-providers/terraform-provider-ignition v1.2.1
-	github.com/ulikunitz/xz v0.5.8 // indirect
-	golang.org/x/crypto v0.0.0-20220112180741-5e0467b6c7ce
+	github.com/stretchr/testify v1.7.2
+	golang.org/x/crypto v0.0.0-20220517005047-85d78b3ac167
 	golang.org/x/lint v0.0.0-20200302205851-738671d3881b
+	golang.org/x/sys v0.0.0-20220517195934-5e4e11fc645e // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	libvirt.org/go/libvirtxml v1.8003.0
 )
@@ -27,3 +24,5 @@ replace git.apache.org/thrift.git => github.com/apache/thrift v0.0.0-20180902110
 replace golang.org/x/crypto v0.0.0-20220112180741-5e0467b6c7ce => github.com/dmacvicar/golang-x-crypto v0.0.0-20220126233154-a96af8f07497
 
 go 1.13
+
+replace github.com/community-terraform-providers/terraform-provider-ignition/v2 => github.com/dmacvicar/terraform-provider-ignition/v2 v2.1.3-0.20210701165004-13acf61ca184

go.sum

@@ -7,7 +7,7 @@ import (
 
 	libvirt "github.com/digitalocean/go-libvirt"
 	uri "github.com/dmacvicar/terraform-provider-libvirt/libvirt/uri"
-	"github.com/hashicorp/terraform-plugin-sdk/helper/mutexkv"
+	"github.com/dmacvicar/terraform-provider-libvirt/libvirt/helper/mutexkv"
 )
 
 // Config struct for the libvirt-provider

libvirt/config.go

@@ -5,8 +5,8 @@ import (
 	"net"
 	"strconv"
 
-	"github.com/hashicorp/terraform-plugin-sdk/helper/hashcode"
-	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/dmacvicar/terraform-provider-libvirt/libvirt/helper/hashcode"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 // a libvirt network DNS host template datasource

libvirt/data_source_libvirt_network.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
-	"github.com/hashicorp/terraform-plugin-sdk/terraform"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
 
 func TestAccLibvirtNetworkDataSource_DNSHostTemplate(t *testing.T) {

libvirt/data_source_libvirt_network_test.go

@@ -13,8 +13,8 @@ import (
 
 	"github.com/davecgh/go-spew/spew"
 	libvirt "github.com/digitalocean/go-libvirt"
-	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
-	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"libvirt.org/go/libvirtxml"
 )
 
@@ -187,6 +187,9 @@ func domainGetIfacesInfo(virConn *libvirt.Libvirt, domain libvirt.Domain, rd *sc
 
 func newDiskForCloudInit(virConn *libvirt.Libvirt, volumeKey string) (libvirtxml.DomainDisk, error) {
 	disk := libvirtxml.DomainDisk{
+		// HACK mark the disk as belonging to the cloudinit
+		// resource so we can ignore it
+		Serial: "cloudinit",
 		Device: "cdrom",
 		Target: &libvirtxml.DomainDiskTarget{
 			// Last device letter possible with a single IDE controller on i440FX

libvirt/domain.go

@@ -6,7 +6,7 @@ import (
 	"os"
 
 	libvirt "github.com/digitalocean/go-libvirt"
-	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"libvirt.org/go/libvirtxml"
 )
 

libvirt/domain_def.go

@@ -0,0 +1,17 @@
+package hashcode
+
+import (
+	"hash/crc32"
+)
+
+func String(s string) int {
+    v := int(crc32.ChecksumIEEE([]byte(s)))
+    if v >= 0 {
+        return v
+    }
+    if -v >= 0 {
+        return -v
+    }
+    // v == MinInt
+    return 0
+}