Merge pull request #7 from vatesfr/client_library

Update xo client library

.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for Go
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/codeql.yml

@@ -0,0 +1,65 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '11 0 * * 5'
+  workflow_dispatch:
+
+jobs:
+  analyze:
+    permissions:
+      security-events: write
+      actions: read
+      contents: read
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - uses: actions/setup-go@v5
+      with:
+        go-version: '1.21'
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+name: lint
+
+on:
+  workflow_call:
+    inputs: {}
+  pull_request:
+    branches:
+    - main
+    - v*
+    - feature*
+
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+    - name: Install go
+      uses: actions/setup-go@v5
+      with:
+        # The versions of golangci-lint and setup-go here cross-depend and need to update together.
+        go-version: '1.23'
+        # Either this action or golangci-lint needs to disable the cache
+        cache: false
+    - run: go mod tidy
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        version: v1.63.2

.github/workflows/release.yml

@@ -0,0 +1,19 @@
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Release
+        uses: codfish/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.gitignore

@@ -0,0 +1,41 @@
+# MacOS DS_Store files
+.DS_Store
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+coverage.html
+
+# Dependency directories (remove the comment below to include it)
+#vendor/
+
+# Output of GoReleaser
+dist/
+
+# Visual Studio Code files
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# GoLand and IntelliJ IDEA files
+.idea/
+
+# env files that usually contain secrets or local config
+.env
+.envrc
+.autoenv.zsh

.golangci.yml

@@ -0,0 +1,24 @@
+linters:
+  enable:
+    - errcheck
+    - goconst
+    - gofmt
+    - gosec
+    - govet
+    - ineffassign
+    - lll
+    - gosimple
+    - staticcheck
+    - unused
+    - misspell
+    - nakedret
+    # - revive # Disable revive linter as it required to rename fields (e.g. Id to ID)
+    - unconvert
+    - unused
+  enable-all: false
+linters-settings:
+  govet:
+    disable:
+      - structtag
+run:
+  timeout: 20m

.releaserc

@@ -0,0 +1,7 @@
+branches:
+  - name: "main"
+
+plugins:
+  - "@semantic-release/commit-analyzer"
+  - "@semantic-release/release-notes-generator"
+  - "@semantic-release/github"

Makefile

@@ -0,0 +1,68 @@
+SHELL := /bin/bash
+
+.DEFAULT_GOAL := all
+.PHONY: all
+all: ## build pipeline
+all: mod gen spell lint test
+
+.PHONY: precommit
+precommit: ## validate the branch before commit
+precommit: all vuln
+
+.PHONY: ci
+ci: ## CI build pipeline
+ci: precommit diff
+
+.PHONY: help
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: clean
+clean: ## remove files created during build pipeline
+	$(call print-target)
+	rm -rf dist
+	rm -f coverage.*
+	rm -f '"$(shell go env GOCACHE)/../golangci-lint"'
+	go clean -i -cache -testcache -modcache -fuzzcache -x
+
+.PHONY: mod
+mod: ## go mod tidy
+	$(call print-target)
+	go mod tidy
+
+.PHONY: gen
+gen: ## go generate
+	$(call print-target)
+	go generate ./...
+
+.PHONY: spell
+spell: ## misspell
+	$(call print-target)
+	misspell -error -locale=US -w **.md
+
+.PHONY: lint
+lint: ## golangci-lint
+	$(call print-target)
+	golangci-lint run
+
+.PHONY: vuln
+vuln: ## govulncheck
+	$(call print-target)
+	govulncheck ./...
+
+.PHONY: test
+test: ## go test
+	$(call print-target)
+	go test -race -covermode=atomic -coverprofile=coverage.out -coverpkg=./... ./...
+	go tool cover -html=coverage.out -o coverage.html
+
+.PHONY: diff
+diff: ## git diff
+	$(call print-target)
+	git diff --exit-code
+	RES=$$(git status --porcelain) ; if [ -n "$$RES" ]; then echo $$RES && exit 1 ; fi
+
+
+define print-target
+    @printf "Executing target: \033[36m$@\033[0m\n"
+endef

README.md

@@ -0,0 +1,26 @@
+# <p align="center">Golang client for XenOrchestra API</p>
+
+This is a Golang module for the [XenOrchestra](https://github.com/vatesfr/xen-orchestra) JSON-RPC API.
+
+It is used in the [terraform-provider-xenorchestra](https://github.com/vatesfr/terraform-provider-xenorchestra) Terraform provider.
+
+## 📚 Documentation 
+
+TODO
+
+## 🧑🏻‍💻 Usage
+
+```shell
+go get github.com/vatesfr/xenorchestra-go-sdk
+```
+
+See [examples](https://github.com/vatesfr/xenorchestra-go-sdk/tree/main/examples).
+
+
+## 🍰 Contributing    
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+## License
+
+MIT License

client/acl.go

@@ -81,6 +81,9 @@ func (c *Client) DeleteAcl(acl Acl) error {
 	var aclRef *Acl
 	if getAclById(acl) {
 		aclRef, err = c.GetAcl(acl)
+		if err != nil {
+			return err
+		}
 		acl = *aclRef
 	}
 	var success bool