Store decoded branch name instead of bytes

[nicogodet]

DESTINATION_BRANCH_TO_USE

• is "declared" as a string

qgis-deployment-toolbelt-cli/qgis_deployment_toolbelt/profiles/profiles_handler_base.py

Line 62 in 38859d1

DESTINATION_BRANCH_TO_USE: str | None = None

• is always populated with a string in :
  • init

  • qgis-deployment-toolbelt-cli/qgis_deployment_toolbelt/profiles/local_git_handler.py

    Lines 98 to 104 in 38859d1

    	self.SOURCE_REPOSITORY_ACTIVE_BRANCH = (
    	self.get_active_branch_from_local_repository()
    	)
    	# check if passed branch exist
    	if branch_to_use is None:
    	self.DESTINATION_BRANCH_TO_USE = self.SOURCE_REPOSITORY_ACTIVE_BRANCH

    def get_active_branch_from_local_repository(self, local_git_repository_path: Path | None = None) -> str:

  • ...

Without this change, the type of this variable becomes mixed str | bytes

But indeed, it needs to be converted to bytes at some point (here) but it's cleaner to let the function handles the conversion instead of store the branch name as bytes

In my case, I relied on str type when testing #661 and I end up comparing "main" with b"main" equals False

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

@@            Coverage Diff             @@
##             main     #664      +/-   ##
==========================================
- Coverage   71.90%   71.84%   -0.07%     
==========================================
  Files          48       48              
  Lines        3271     3271              
  Branches      576      576              
==========================================
- Hits         2352     2350       -2     
- Misses        704      705       +1     
- Partials      215      216       +1     

Flag	Coverage Δ
unittests	71.23% <ø> (-0.07%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...loyment_toolbelt/profiles/profiles_handler_base.py	69.23% <ø> (-1.10%)	⬇️

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Guts]

Hello @nicogodet,

Can you explain a bit why this change please?

[nicogodet]

Hello @nicogodet,

Can you explain a bit why this change please?

DESTINATION_BRANCH_TO_USE

• is "declared" as a string

qgis-deployment-toolbelt-cli/qgis_deployment_toolbelt/profiles/profiles_handler_base.py

Line 62 in 38859d1

DESTINATION_BRANCH_TO_USE: str | None = None

• is always populated with a string in :
  • init

  • qgis-deployment-toolbelt-cli/qgis_deployment_toolbelt/profiles/local_git_handler.py

    Lines 98 to 104 in 38859d1

    	self.SOURCE_REPOSITORY_ACTIVE_BRANCH = (
    	self.get_active_branch_from_local_repository()
    	)
    	# check if passed branch exist
    	if branch_to_use is None:
    	self.DESTINATION_BRANCH_TO_USE = self.SOURCE_REPOSITORY_ACTIVE_BRANCH

    def get_active_branch_from_local_repository(self, local_git_repository_path: Path | None = None) -> str:

  • ...

Without this change, the type of this variable becomes mixed str | bytes

But indeed, it needs to be converted to bytes at some point (here) but it's cleaner to let the function handles the conversion instead of store the branch name as bytes

In my case, I relied on str type when testing #661 and I end up comparing "main" with b"main" equals False

[Guts]

I've tested locally in different circumstances and it looks that it did not break anything, so let's move on!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud