Release 0.4.4 (#1441)

# Description Please describe the change you have made. ## Checklist - [ ] Prefixed the PR title with the Jira issue number on the form `[CDF-12345]`. - [ ] Tests added/updated. - [ ] Run Demo Job Locally. - [ ] Documentation updated. - [ ] Changelogs updated in [CHANGELOG.cdf-tk.md](https://github.com/cognitedata/toolkit/blob/main/CHANGELOG.cdf-tk.md). - [ ] Template changelogs updated in [CHANGELOG.templates.md](https://github.com/cognitedata/toolkit/blob/main/CHANGELOG.templates.md). [CDF-12345]: https://cognitedata.atlassian.net/browse/CDF-12345?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
cognitedata · Feb 5, 2025 · a908ad1 · a908ad1
2 parents 655fd15 + ec058e0
commit a908ad1
Show file tree

Hide file tree

Showing 21 changed files with 36 additions and 26 deletions.
diff --git a/CHANGELOG.cdf-tk.md b/CHANGELOG.cdf-tk.md
@@ -15,6 +15,12 @@ Changes are grouped as follows:
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [0.4.4] - 2025-02-05
+
+### Fixed
+
+- Deploying functions containing files that are not `utf-8` encoded no longer raises a `UnicodeDecodeError`.
+
 ## [0.4.3] - 2025-02-04
 
 ### Fixed

diff --git a/CHANGELOG.templates.md b/CHANGELOG.templates.md
@@ -15,6 +15,10 @@ Changes are grouped as follows:
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [0.4.4] - 2025-02-05
+
+No changes to templates.
+
 ## [0.4.3] - 2025-02-04
 
 No changes to templates.

diff --git a/cdf.toml b/cdf.toml
@@ -16,4 +16,4 @@ dump = true
 [modules]
 # This is the version of the modules. It should'n be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
diff --git a/cognite_toolkit/_builtin_modules/cdf.toml b/cognite_toolkit/_builtin_modules/cdf.toml
@@ -4,7 +4,7 @@ default_env = "<DEFAULT_ENV_PLACEHOLDER>"
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
 
 
 [plugins]

diff --git a/cognite_toolkit/_cdf_tk/commands/build.py b/cognite_toolkit/_cdf_tk/commands/build.py
@@ -468,7 +468,10 @@ def _replace_variables(
                 self.console(f"Processing file {source_path.name}...")
 
             content = safe_read(source_path)
-            source = SourceLocationEager(source_path, calculate_str_or_file_hash(content, shorten=True))
+            # We cannot use the content as the basis for hash as this have been encoded.
+            # Instead, we use the source path, which will hash the bytes of the file directly,
+            # which is what we do in the deploy step to verify that the source file has not changed.
+            source = SourceLocationEager(source_path, calculate_str_or_file_hash(source_path, shorten=True))
 
             content = variables.replace(content, source_path.suffix)
 

diff --git a/cognite_toolkit/_cdf_tk/utils/hashing.py b/cognite_toolkit/_cdf_tk/utils/hashing.py
@@ -42,15 +42,11 @@ def calculate_secure_hash(item: dict[str, Any]) -> str:
 
 
 def calculate_str_or_file_hash(content: str | Path, shorten: bool = False) -> str:
-    sha256_hash = hashlib.sha256()
-    if isinstance(content, Path):
-        content = content.read_text("utf-8")
-    # Get rid of Windows line endings to make the hash consistent across platforms.
-    sha256_hash.update(content.encode("utf-8").replace(b"\r\n", b"\n"))
-    calculated = sha256_hash.hexdigest()
-    if shorten:
-        return calculated[:8]
-    return calculated
+    if isinstance(content, str):
+        byte_content = content.encode("utf-8")
+    else:
+        byte_content = content.read_bytes()
+    return calculate_bytes_or_file_hash(byte_content, shorten)
 
 
 def calculate_bytes_or_file_hash(content: bytes | Path, shorten: bool = False) -> str:

diff --git a/cognite_toolkit/_repo_files/AzureDevOps/.devops/deploy-pipeline.yml b/cognite_toolkit/_repo_files/AzureDevOps/.devops/deploy-pipeline.yml
@@ -14,7 +14,7 @@ jobs:
     pool:
       vmImage: 'ubuntu-latest'
     container: 
-      image: 'cognite/toolkit:0.4.3'
+      image: 'cognite/toolkit:0.4.4'
       env:
         CDF_CLUSTER: $(CDF_CLUSTER)
         CDF_PROJECT: $(CDF_PROJECT)

diff --git a/cognite_toolkit/_repo_files/AzureDevOps/.devops/dry-run-pipeline.yml b/cognite_toolkit/_repo_files/AzureDevOps/.devops/dry-run-pipeline.yml
@@ -16,7 +16,7 @@ jobs:
     pool:
       vmImage: 'ubuntu-latest'
     container: 
-      image: 'cognite/toolkit:0.4.3'
+      image: 'cognite/toolkit:0.4.4'
       env:
         CDF_CLUSTER: $(CDF_CLUSTER)
         CDF_PROJECT: $(CDF_PROJECT)

diff --git a/cognite_toolkit/_repo_files/GitHub/.github/workflows/build.yaml b/cognite_toolkit/_repo_files/GitHub/.github/workflows/build.yaml
@@ -10,7 +10,7 @@ jobs:
     environment: dev
     name: Deploy Dry Run
     container:
-      image: cognite/toolkit:0.4.3
+      image: cognite/toolkit:0.4.4
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

diff --git a/cognite_toolkit/_repo_files/GitHub/.github/workflows/deploy.yaml b/cognite_toolkit/_repo_files/GitHub/.github/workflows/deploy.yaml
@@ -12,7 +12,7 @@ jobs:
     environment: dev
     name: Deploy
     container:
-      image: cognite/toolkit:0.4.3
+      image: cognite/toolkit:0.4.4
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

diff --git a/cognite_toolkit/_version.py b/cognite_toolkit/_version.py
@@ -1 +1 @@
-__version__ = "0.4.3"
+__version__ = "0.4.4"
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "cognite_toolkit"
-version = "0.4.3"
+version = "0.4.4"
 description = "Official Cognite Data Fusion tool for project templates and configuration deployment"
 authors = [
     {name ="Cognite AS", email="support@cognite.com"}

diff --git a/tests/data/build_group_with_unknown_acl/_build_environment.yaml b/tests/data/build_group_with_unknown_acl/_build_environment.yaml
@@ -4,4 +4,4 @@ project: pytest-project
 type: dev
 selected:
 - modules
-cdf_toolkit_version: 0.4.3
+cdf_toolkit_version: 0.4.4
diff --git a/tests/data/cdf_toml_data/cdf.toml b/tests/data/cdf_toml_data/cdf.toml
@@ -1,7 +1,7 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
 
 [plugins]
 graphql = true

diff --git a/tests/data/complete_org/cdf.toml b/tests/data/complete_org/cdf.toml
@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
diff --git a/tests/data/complete_org_alpha_flags/cdf.toml b/tests/data/complete_org_alpha_flags/cdf.toml
@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
diff --git a/tests/data/project_no_cognite_modules/cdf.toml b/tests/data/project_no_cognite_modules/cdf.toml
@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
diff --git a/tests/data/project_with_bad_modules/cdf.toml b/tests/data/project_with_bad_modules/cdf.toml
@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
diff --git a/tests/data/project_with_duplicates/cdf.toml b/tests/data/project_with_duplicates/cdf.toml
@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
diff --git a/tests/data/run_data/cdf.toml b/tests/data/run_data/cdf.toml
@@ -1,7 +1,7 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf module upgrade' command.
-version = "0.4.3"
+version = "0.4.4"
 
 [modules.packages]
 cdf_infield = [

diff --git a/tests/test_unit/test_cdf_tk/test_commands/test_build.py b/tests/test_unit/test_cdf_tk/test_commands/test_build.py
@@ -99,6 +99,7 @@ def test_build_valid_read_int_version(self) -> None:
         source_filepath = MagicMock(spec=Path)
         source_filepath.read_text.return_value = raw_yaml
         source_filepath.suffix = ".yaml"
+        source_filepath.read_bytes.return_value = raw_yaml.encode("utf-8")
 
         source_files = cmd._replace_variables(
             [source_filepath], BuildVariables([]), TransformationLoader.folder_name, Path("my_module"), verbose=False