oracle.oci.oci_devops_file_diff_response_facts – Fetches details about a FileDiffResponse resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_devops_file_diff_response_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a FileDiffResponse resource in Oracle Cloud Infrastructure

  • Gets the line-by-line difference between file on different commits. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has ‘/’. This will be replaced by “/repositories/{repositoryId}/file/diffs”

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
base_version
string / required
The branch to compare changes against.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
file_path
string / required
Path to a file within a repository.
is_comparison_from_merge_base
boolean
    Choices:
  • no
  • yes
Boolean to indicate whether to use merge base or most recent revision.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
repository_id
string / required
Unique repository identifier.
target_version
string / required
The branch where changes are coming from.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Get a specific file_diff_response
  oci_devops_file_diff_response_facts:
    # required
    repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
    file_path: file_path_example
    base_version: base_version_example
    target_version: target_version_example

    # optional
    is_comparison_from_merge_base: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
file_diff_response
complex
on success
FileDiffResponse resource

Sample:
{'are_conflicts_in_file': True, 'changes': [{'base_line': 56, 'base_span': 56, 'diff_sections': [{'lines': [{'base_line': 56, 'conflict_marker': 'BASE', 'line_content': 'line_content_example', 'target_line': 56}], 'type': 'type_example'}], 'target_line': 56, 'target_span': 56}], 'is_binary': True, 'is_large': True, 'new_id': 'ocid1.new.oc1..xxxxxxEXAMPLExxxxxx', 'new_path': 'new_path_example', 'old_id': 'ocid1.old.oc1..xxxxxxEXAMPLExxxxxx', 'old_path': 'old_path_example'}
 
are_conflicts_in_file
boolean
on success
Indicates whether the changed file contains conflicts.

Sample:
True
 
changes
complex
on success
List of changed section in the file.

   
base_line
integer
on success
Line number in base version where changes begin.

Sample:
56
   
base_span
integer
on success
Number of lines chunk spans in base version.

Sample:
56
   
diff_sections
complex
on success
List of difference section.

     
lines
complex
on success
The lines within changed section.

       
base_line
integer
on success
The number of a line in the base version.

Sample:
56
       
conflict_marker
string
on success
Indicates whether a line in a conflicted section of the difference is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section.

Sample:
BASE
       
line_content
string
on success
The contents of a line.

Sample:
line_content_example
       
target_line
integer
on success
The number of a line in the target version.

Sample:
56
     
type
string
on success
Type of change.

Sample:
type_example
   
target_line
integer
on success
Line number in target version where changes begin.

Sample:
56
   
target_span
integer
on success
Number of lines chunk spans in target version.

Sample:
56
 
is_binary
boolean
on success
Indicates whether the file is binary.

Sample:
True
 
is_large
boolean
on success
Indicates whether the file is large.

Sample:
True
 
new_id
string
on success
The ID of the changed object on the target version.

Sample:
ocid1.new.oc1..xxxxxxEXAMPLExxxxxx
 
new_path
string
on success
The path on the target version to the changed object.

Sample:
new_path_example
 
old_id
string
on success
The ID of the changed object on the base version.

Sample:
ocid1.old.oc1..xxxxxxEXAMPLExxxxxx
 
old_path
string
on success
The path on the base version to the changed object.

Sample:
old_path_example


Authors

  • Oracle (@oracle)