Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(job_attachment)!: Change osType and source_os names #45

Merged
merged 1 commit into from
Sep 21, 2023

Conversation

gahyusuh
Copy link
Contributor

@gahyusuh gahyusuh commented Sep 19, 2023

⚠️ Please use caution before merging, as it requires a preceding change to the backend service model. For more details, please contact @gahyusuh 🙏

What was the problem/requirement? (What/Why)

The field osType: OperatingSystemFamily in job/attachments/manifests is currently being used just to determine how to handle the rootPath (i.e., is it 'posix' or 'windows',) in the API, so it follows more closely with the path mapping rules rather than storage profiles. The field osType in job attachment settings should be renamed to something else, to avoid inconsistencies around the usage of osType, osFamily, and whatever encapsulates 'windows' vs. 'posix' paths.

What was the solution? (How)

  • Renamed the field osType: OperatingSystemFamily -> rootPathFormat: PathFormat
  • Changed the path mapping rules that are returned from the sync_inputs from source_os to source_path_format

What is the impact of this change?

The field has a better/less-confusing name.

How was this change tested?

  • Ran unit tests: hatch run lint && hatch run test
  • Ran integ tests: hatch run integ:test
  • Ran docker-based tests: hatch run test_docker
  • Run an end-to-end test (submitting a non-rendering job bundle --> running a CMF against my local backend)

Was this change documented?

No.

Is this a breaking change?

Yes!

@gahyusuh gahyusuh force-pushed the gahyusuh/rename_os_type branch 2 times, most recently from d8f730c to c7c9d44 Compare September 21, 2023 14:00
BREAKING CHANGES:
- Renamed the field `osType: OperatingSystemFamily` -> `rootPathFormat: PathFormat`
- Changed the path mapping rules that are returned from the `sync_inputs` from `source_os` to `source_path_format`

Signed-off-by: Gahyun Suh <gahyusuh@dev-dsk-gahyusuh-2a-387e0b51.us-west-2.amazon.com>
@epmog epmog merged commit d1cf934 into mainline Sep 21, 2023
18 checks passed
@epmog epmog deleted the gahyusuh/rename_os_type branch September 21, 2023 20:44
epmog added a commit that referenced this pull request Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants