Cjlapao/implement devops new schema (#74)

* Hotfix 271124-1

- Fixed some issues with the ensure processes where we could get nil pointers
- Added a new process to delete vms that were created but the creation process failed
- Added the enforce of the flag force_changes on the create where it will delete vms if the pre-exist
- Fixed some issues with the getVms method where the id was not being escaped
- Added a fix for the intel macs where we now add the user to the sudoers list if not present
- Added a fix where if PD failed to install we would get an error with dependencies

* added initial new schema for deployment

* wip

* fixed lint issues

* Some minor improvements in stability and small

- Fixed an issue where if the api stopped responding the provider would crash
- Added better context timeout to the state and remote_vm providers

Author: cjlapao

.github/workflows/codeql-analysis.yml

@@ -1,15 +1,9 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
 name: 'CodeQL'
 
 on:
   push:
     branches: [main]
   pull_request:
-    # The branches below must be a subset of the branches above
     branches: [main]
   schedule:
     - cron: '0 7 * * 2'
@@ -22,22 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Override automatic language detection by changing the below list
-        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
         language: ['go']
-        # Learn more...
-        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          # We must fetch at least the immediate parents so that if this is
-          # a pull request then we can checkout the head.
           fetch-depth: 2
-
-      # If this run was triggered by a pull request event, then checkout
-      # the head of the pull request instead of the merge commit.
+      - name: Setup Go
+        uses: actions/setup-go@v4
+        with:
+          go-version-file: 'go.mod'
       - run: git checkout HEAD^2
         if: ${{ github.event_name == 'pull_request' }}
 
@@ -46,26 +35,8 @@ jobs:
         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

.gitignore

@@ -35,5 +35,7 @@ website/vendor
 *.winfile eol=crlf
 
 terraform-provider-*
+*.local.*
+*.tmp*
 .local/
-__debug*
+__debug*

CHANGELOG.md

@@ -1,10 +1,10 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.5.10] - 2025-01-21
-
+# Changelog
+
+All notable changes to this project will be documented in this file.
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.10] - 2025-01-21
+
 - Added a publish pipeline
 - Fixed an issue with the generate-changelog.sh
 - Added an announcement automation for discord
@@ -34,7 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed an issue where if we enabled the HTTPS for a host and registered it with an orchestrator, it would fail due to the wrong port
 - Added the new resource called vm_state to set an existing VM to a state
 - Fixed an issue in the telemetry not being sent correctly
-- Fixed #53 an issue where the specs where not being applied correctly if the machine was stop at some points 
+- Fixed #53 an issue where the specs where not being applied correctly if the machine was stop at some points
 - Fixed an issue where the specs cpu_count and memory_count where not being calculated correctly
 - Resolved #54 Added the ability to use the vm datasource with the orchestrator
 - Resolved #58 Added the new shared block to allow port forwarding in the the following providers, clone_vm, remote_image, vagrant_box and deploy
@@ -51,24 +51,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added an option to update the devops service in a deploy resource
 - fixed a bug where the deploy resource would update but failed to report correctly
 - Fixed an issue with the client apiresponse being empty
--  Added better error messages when checking for resources
+- Added better error messages when checking for resources
 - Fixed an issue where by mistake the remoteimage was reporting it did not support  orchestrator
 - Fixed an issue where remote_vm, vagrant_box and clone_vm would fail if this was pointing to an orchestrator
 - Added the ability of only running post scripts if something changed on them
 - Added the ability to disbale tls validation for self signed certificates
 - Fixed an issue with the https format for the orchestrator
-
-
-## [0.2.2] - 2023-01-01
-
-- Fixed an issue that was preventing the deployment from linux machines
-- Removed some unnecessary files
-
-## [0.2.0] - 2023-01-01
-
-FEATURES:
-
-- Fixed some bugs
-- Added the ability to register a deployment with a orchestrator
-- Added the ability to run prlctl commands
-- Added the ability to run a script on destroy it
+
+
+## [0.2.2] - 2023-01-01
+
+- Fixed an issue that was preventing the deployment from linux machines
+- Removed some unnecessary files
+
+## [0.2.0] - 2023-01-01
+
+FEATURES:
+
+- Fixed some bugs
+- Added the ability to register a deployment with a orchestrator
+- Added the ability to run prlctl commands
+- Added the ability to run a script on destroy it

internal/apiclient/register_with_orchestrator.go

@@ -15,7 +15,7 @@ import (
 func RegisterWithOrchestrator(ctx context.Context, config HostConfig, request apimodels.OrchestratorHostRequest) (*apimodels.OrchestratorHostResponse, diag.Diagnostics) {
 	diagnostics := diag.Diagnostics{}
 	urlHost := helpers.GetHostUrl(config.Host)
-	url := helpers.GetHostApiVersionedBaseUrl(urlHost) + "%s/orchestrator/hosts"
+	url := helpers.GetHostApiVersionedBaseUrl(urlHost) + "/orchestrator/hosts"
 
 	auth, err := authenticator.GetAuthenticator(ctx, urlHost, config.License, config.Authorization, config.DisableTlsValidation)
 	if err != nil {

internal/apiclient/set_machine_state.go

@@ -45,6 +45,10 @@ func SetMachineState(ctx context.Context, config HostConfig, machineId string, o
 		diagnostics = append(diagnostics, diag...)
 		return false, diagnostics
 	}
+	if vm == nil {
+		diagnostics.AddError("There was an error getting the vm", "vm is nil")
+		return false, diagnostics
+	}
 
 	if vm.State == string(op) {
 		tflog.Info(ctx, fmt.Sprintf("Machine %s is already in state %s", machineId, op))

internal/deploy/devops_service.go

@@ -5,6 +5,7 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
+	"math/big"
 	"path/filepath"
 	"strings"
 
@@ -509,7 +510,7 @@ func (c *DevOpsServiceClient) CompareLicenses(ctx context.Context, license strin
 	return false, nil
 }
 
-func (c *DevOpsServiceClient) InstallDevOpsService(ctx context.Context, license string, config models.ParallelsDesktopDevopsConfigV2) (string, error) {
+func (c *DevOpsServiceClient) InstallDevOpsService(ctx context.Context, license string, config models.ParallelsDesktopDevopsConfigV3) (string, error) {
 	// Installing DevOps Service
 
 	devopsPath := c.findPath(ctx, "prldevops")
@@ -552,6 +553,37 @@ func (c *DevOpsServiceClient) InstallDevOpsService(ctx context.Context, license
 		if config.EnablePortForwarding.ValueBool() {
 			configFile.EnvironmentVariables["ENABLE_REVERSE_PROXY"] = "true"
 		}
+		// Setting the caching options for the service
+		if config.CatalogCacheKeepFreeDiskSpace.ValueBigFloat() != nil {
+			configValue := config.CatalogCacheKeepFreeDiskSpace.ValueBigFloat()
+			zeroValue := big.NewFloat(0)
+			if configValue.Cmp(zeroValue) == 1 {
+				configFile.EnvironmentVariables["CATALOG_CACHE_KEEP_FREE_DISK_SPACE"] = config.CatalogCacheKeepFreeDiskSpace.ValueBigFloat().String()
+			}
+		}
+		if config.CatalogCacheMaxSize.ValueBigFloat() != nil {
+			configValue := config.CatalogCacheMaxSize.ValueBigFloat()
+			zeroValue := big.NewFloat(0)
+			if configValue.Cmp(zeroValue) == 1 {
+				configFile.EnvironmentVariables["CATALOG_CACHE_MAX_SIZE"] = config.CatalogCacheMaxSize.ValueBigFloat().String()
+			}
+		}
+		if config.CatalogCacheAllowCacheAboveKeepFreeDiskSpace.ValueBool() {
+			configFile.EnvironmentVariables["CATALOG_CACHE_ALLOW_CACHE_ABOVE_KEEP_FREE_DISK_SPACE"] = "true"
+		}
+		if config.DisableCatalogCachingStream.ValueBool() {
+			configFile.EnvironmentVariables["DISABLE_CATALOG_PROVIDER_STREAMING"] = "true"
+		}
+
+		// Setting the logging options for the service
+		if config.EnableLogging.ValueBool() {
+			configFile.EnvironmentVariables["PRL_DEVOPS_LOG_TO_FILE"] = "true"
+		}
+		if config.LogPath.ValueString() != "" {
+			configFile.EnvironmentVariables["PRL_DEVOPS_LOG_FILE_PATH"] = config.LogPath.ValueString()
+		} else {
+			configFile.EnvironmentVariables["PRL_DEVOPS_LOG_FILE_PATH"] = "."
+		}
 
 		yamlConfig, err := yaml.Marshal(configFile)
 		if err != nil {
@@ -704,7 +736,7 @@ func (c *DevOpsServiceClient) GenerateDefaultRootPassword(ctx context.Context) (
 	return encoded, nil
 }
 
-func (c *DevOpsServiceClient) generateConfigFile(config models.ParallelsDesktopDevopsConfigV2) (string, error) {
+func (c *DevOpsServiceClient) generateConfigFile(config models.ParallelsDesktopDevopsConfigV3) (string, error) {
 	configPath := "/tmp/service_config.json"
 	configMap := make(map[string]interface{})
 	if config.Port.ValueString() != "" {
@@ -758,9 +790,6 @@ func (c *DevOpsServiceClient) generateConfigFile(config models.ParallelsDesktopD
 	if config.SystemReservedDisk.ValueString() != "" {
 		configMap["system_reserved_disk"] = config.SystemReservedDisk.ValueString()
 	}
-	if config.EnableLogging.ValueBool() {
-		configMap["log_output"] = true
-	}
 
 	jsonConfig, err := json.Marshal(configMap)
 	if err != nil {

internal/deploy/models/common.go

@@ -73,7 +73,7 @@ func (p *ParallelsDesktopDevOps) MapObject() basetypes.ObjectValue {
 	return types.ObjectValueMust(attributeTypes, attrs)
 }
 
-func ApiConfigHasChanges(context context.Context, planState, currentState *ParallelsDesktopDevopsConfigV2) bool {
+func ApiConfigHasChanges(context context.Context, planState, currentState *ParallelsDesktopDevopsConfigV3) bool {
 	if planState == nil && currentState == nil {
 		return false
 	}
@@ -162,6 +162,34 @@ func ApiConfigHasChanges(context context.Context, planState, currentState *Paral
 		return true
 	}
 
+	if planState.LogPath != currentState.LogPath {
+		return true
+	}
+
+	if planState.EnablePortForwarding != currentState.EnablePortForwarding {
+		return true
+	}
+
+	if planState.UseLatestBeta != currentState.UseLatestBeta {
+		return true
+	}
+
+	if planState.CatalogCacheAllowCacheAboveKeepFreeDiskSpace != currentState.CatalogCacheAllowCacheAboveKeepFreeDiskSpace {
+		return true
+	}
+
+	if planState.CatalogCacheKeepFreeDiskSpace != currentState.CatalogCacheKeepFreeDiskSpace {
+		return true
+	}
+
+	if planState.CatalogCacheMaxSize != currentState.CatalogCacheMaxSize {
+		return true
+	}
+
+	if planState.DisableCatalogCachingStream != currentState.DisableCatalogCachingStream {
+		return true
+	}
+
 	if len(planState.EnvironmentVariables) != len(currentState.EnvironmentVariables) {
 		return true
 	}