Merge pull request #40 from CycloneDX/fix/issue-39-windows-UnicodeEncodeError

FIX: Resolve file encoding issues on Windows

Author: madpah

.github/workflows/poetry.yml

@@ -44,20 +44,25 @@ jobs:
         run: poetry run tox -e flake8
 
   build-and-test:
-    name: Build & Test (Python ${{ matrix.python-version }}
-    runs-on: ubuntu-latest
+    name: Build & Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     env:
       REPORTS_ARTIFACT: tests-reports
     strategy:
       fail-fast: false
       matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
         python-version:
           - "3.9" # highest supported
           - "3.8"
           - "3.7"
           - "3.6" # lowest supported
     timeout-minutes: 30
     steps:
+      - name: Disabled Git auto EOL CRLF transforms
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
       - name: Checkout
         # see https://github.com/actions/checkout
         uses: actions/checkout@v2
@@ -69,6 +74,8 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           architecture: 'x64'
+      - name: Validate Python Environment
+        run: echo "import sys; print('Python %s on %s in %s' % (sys.version, sys.platform, sys.getdefaultencoding()))" | python
       - name: Install poetry
         # see https://github.com/marketplace/actions/setup-poetry
         uses: Gr1N/setup-poetry@v7
@@ -77,7 +84,7 @@ jobs:
       - uses: actions/cache@v2
         with:
           path: ~/.cache/pypoetry/virtualenvs
-          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+          key: ${{ runner.os }}}-${{ matrix.python-version }}-poetry-${{ hashFiles('poetry.lock') }}
       - name: Install dependencies
         run: poetry install
       - name: Ensure build successful
@@ -87,7 +94,7 @@ jobs:
       - name: Generate coverage reports
         run: >
           poetry run coverage report &&
-          poetry run coverage xml -o ${{ env.REPORTS_DIR }}/coverage.xml &&
+          poetry run coverage xml -o ${{ env.REPORTS_DIR }}/coverage-${{ matrix.os }}-${{ matrix.python-version }}.xml &&
           poetry run coverage html -d ${{ env.REPORTS_DIR }}
       - name: Artifact reports
         if: ${{ ! cancelled() }}

cyclonedx/model/__init__.py

@@ -39,11 +39,9 @@ def sha1sum(filename: str) -> str:
         SHA-1 hash
     """
     h = hashlib.sha1()
-    b = bytearray(128 * 1024)
-    mv = memoryview(b)
-    with open(filename, 'rb', buffering=0) as f:
-        for n in iter(lambda: f.readinto(mv), 0):
-            h.update(mv[:n])
+    with open(filename, 'rb') as f:
+        for byte_block in iter(lambda: f.read(4096), b""):
+            h.update(byte_block)
     return h.hexdigest()
 
 

cyclonedx/output/__init__.py

@@ -70,7 +70,7 @@ def output_to_file(self, filename: str, allow_overwrite: bool = False):
             raise FileExistsError
 
         with open(output_filename, mode='w') as f_out:
-            f_out.write(self.output_as_string())
+            f_out.write(self.output_as_string(), encoding='utf-8')
 
         f_out.close()