Add support for add subcommand to scaffold devfile resources

[tanwigeetika1618]

JIRA ticket: https://issues.redhat.com/browse/AAP-27897
Related Issue : #148

Description:

This commit introduces a new add subcommand to the ansible-creator tool, allowing users to scaffold resources like devfile into an existing project. This feature is designed to streamline the development environment setup by automatically generating the necessary configuration files.

Changes:

• Created add.py: Added the add subcommand to scaffold:
  • devfile resource setup
• Updated config.py: Added new attributes to support the add subcommand:
  • resource_type: Specifies the resource type (e.g. devfile).
  • path: Defines the target path for the resource scaffolding.
  • type: Denotes the type of resource being scaffolded.

Unit Tests for add Subcommand:

• Created test_add.py:

  • Added unit tests for the add subcommand in the units folder.

• Test Functions:

  1. Successful Scaffolding: Validates that the add subcommand correctly scaffolds the devfile.yaml from the fixtures folder to the temporary path.
  2. Overwrite Scenario: Modifies the devfile.yaml content and checks the behavior of the overwrite parameter, ensuring that conflicts are handled appropriately during scaffolding.

• Fixtures:

  • Added a devfile.yaml to the fixtures/common/devfile folder for testing purposes.

Notes:

Subcommand add Behavior:

1. When the devfile.yaml is not present in the provided path:

   • The add subcommand scaffolds the devfile.yaml and outputs the message:
     • Note: Resource added to /path/to/directory

2. When the devfile.yaml exists in the provided path with the same content:

   • If the devfile.yaml has not been altered (i.e., content matches the original file), the subcommand does not overwrite the file and outputs the same message:
     • Note: Resource added to /path/to/directory

3. When the devfile.yaml exists in the provided path but has different content:

   • If the devfile.yaml has been modified, the subcommand detects the change and prompts:

     • Files in the destination directory will be overwritten. Do you want to proceed? (y/n)

   • If the user chooses 'y' (Yes):

     • The file is overwritten, and the message confirms the update:
       • Note: Resource added to /path/to/directory

   • If the user chooses 'n' (No):

     • The operation is aborted, and the following warning and error messages are shown:
       • Warning: /path/to/directory/devfile.yaml already exists
       • Files in the destination directory will be overwritten. Do you want to proceed? (y/n): n
       • Error: The destination directory contains files that will be overwritten. Please re-run ansible-creator with --overwrite to continue.

   • Using the --overwrite flag:

     • If the user runs the command with the --overwrite flag:
       • ansible-creator add resource devfile /path/to/directory --overwrite
     • The devfile.yaml is overwritten, and the message confirms successful scaffolding:
       • Note: Resource added to /path/to/directory

• This PR enhances the existing functionality of the ansible-creator tool by making it easier to add development environment configurations to existing projects.

[shatakshiiii]

@tanwigeetika1618, can we also update the docs to mention a bit about add here: https://ansible.readthedocs.io/projects/creator/ ?

Can happen in a separate PR as well!

Sorted