Fix changes status and return diff information when state=touch and c… #59341

DSNortsev · 2019-07-20T22:13:24Z

SUMMARY

Fixes #50452

Add check_model parameter to update_timestamp_for_file function and the file timestamp
only updates when check_mode is set to False (default option)
Changed is set to TRUE if file does not exist or the access_time and modification_time
option are not set to preserve

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

file

ADDITIONAL INFORMATION

Playbook:

---
- hosts: localhost
  connection: local
  tasks:

  - name: Ensure file for specifications
    file:
      path: /tmp/test
      state: touch

Playbook when access_time and modification_time are preserve:

---
- hosts: localhost
  connection: local
  gather_facts: no
  tasks:
    - name: Ensure file for specifications
      file:
        path: /tmp/test
        state: touch
        access_time: preserve
        modification_time: preserve

Before Fix:

ok: [localhost] => {
    "changed": false,
    "dest": "/tmp/test",
    "gid": 1001,
    "group": "dmitry",
    "invocation"

After Fix if file does not exist:

changed: [localhost] => {
    "changed": true,
    "dest": "/tmp/test",
    "invocation": {
        "module_args":

After Fix if file exists:

changed: [localhost] => {
    "changed": true,
    "dest": "/tmp/test",
    "diff": {
        "after": {
            "atime": 1557243232.714623,
            "mtime": 1557243232.714623,
            "path": "/tmp/test",
            "state": "touch"
        },
        "before": {
            "atime": 1557243223.6023092,
            "mtime": 1557243223.6023092,
            "path": "/tmp/test",
            "state": "file"
        }
    }

After fix if acccess_time and modification_time are set to preserve:

    "changed": false,
    "dest": "/tmp/test",
    "gid": 1001,
    "group": "dmitry",
    "invocation":

DSNortsev · 2019-07-20T22:23:21Z

@bcoca I accidentally closed my previous PR #59219 and was not able to re-open it. I had to create e new one. Also, I am planning to add integration tests.

DSNortsev · 2019-07-21T16:57:37Z

@DSNortsev , would be cool to see integration tests
test/integration/targets/file/tasks/main.yml I saw file module tests there

@Andersson007, I added integration tests. Please take a look when you have a chance. Thanks

Andersson007

Thanks, several cosmetic suggestions.
I can't take a deep review now, maybe later

Andersson007 · 2019-07-22T06:02:18Z

test/integration/targets/file/tasks/main.yml

+
+- name: verify touch updates only mtime when atime is preserved
+  file: path={{output_dir}}/foo.txt state=touch access_time=preserve
+


Suggested change

Andersson007 · 2019-07-22T06:02:30Z

test/integration/targets/file/tasks/main.yml

+
+- name: verify touch updated only atime when mtime is preserved
+  file: path={{output_dir}}/foo.txt state=touch modification_time=preserve
+


Suggested change

Andersson007 · 2019-07-22T06:03:41Z

changelogs/fragments/touch_fix.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+  - file - Fix changed status and return diff information in file module when state=touch and check mode is set https://github.com/ansible/ansible/issues/50452


Suggested change

- file - Fix changed status and return diff information in file module when state=touch and check mode is set https://github.com/ansible/ansible/issues/50452

- file - Fix changed status and return diff information in file module when state=touch and check mode is set (https://github.com/ansible/ansible/issues/50452)

Andersson007 · 2019-07-22T06:07:05Z

test/units/modules/files/test_file.py

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# Copyright:
+#   (c) 2018 Ansible Project


Suggested change

# (c) 2018 Ansible Project

Andersson007 · 2019-07-22T06:07:39Z

test/units/modules/files/test_file.py

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# Copyright:


Suggested change

# Copyright:

# Copyright: 2018 Ansible Project

ansibot · 2019-07-31T17:48:31Z

The test ansible-test sanity --test future-import-boilerplate [explain] failed with 1 error:

test/units/modules/files/test_file.py:0:0: missing: from __future__ import (absolute_import, division, print_function)

click here for bot help

…heck_mode is set Fixes ansible#50452 * Add check_model parameter to update_timestamp_for_file function and the file timestamp only updates when check_mode is set to False (default option) * Changed is set to TRUE if file does not exist or the access_time and modification_time option are not set to preserve * Add unittest to test touch module in check mode Signed-off-by: Dmitry Nortsev <dmitry.nortsev@gmail.com>

Akasurde · 2020-06-18T08:28:35Z

@DSNortsev Could you please rebase the PR using https://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html? Thanks.

s-hertel

This looks good. lib/ansible/modules/files/file.py should now be lib/ansible/modules/file.py.

s-hertel · 2020-06-19T18:26:28Z

lib/ansible/modules/files/file.py

+        # parameters are not set to "preserve"
+        if prev_state == 'absent':
+            result['changed'] = True
+        elif module.params['access_time'] != 'preserve' or module.params['modification_time'] != 'preserve':


this is handled by update_timestamp_for_file. You can simplify this and just do an if/else

Suggested change

elif module.params['access_time'] != 'preserve' or module.params['modification_time'] != 'preserve':

else:

s-hertel · 2020-06-19T18:42:02Z

lib/ansible/modules/files/file.py

+        if prev_state == 'absent':
+            result['changed'] = True
+        elif module.params['access_time'] != 'preserve' or module.params['modification_time'] != 'preserve':
+            result['changed'] = True


Remove this and add it to the conditional below

Suggested change

result['changed'] = True

s-hertel · 2020-06-19T18:42:06Z

lib/ansible/modules/files/file.py

+            file_args = module.load_file_common_arguments(module.params)
+            # Attach diff to result only when the file exists
+            if update_timestamp_for_file(file_args['path'], mtime, atime, diff, check_mode=True):
+                result['diff'] = diff


Suggested change

result['diff'] = diff

result['diff'] = diff

result['changed'] = True

Andersson007 · 2020-07-21T07:32:34Z

@DSNortsev any updates on this?

sivel · 2022-11-30T19:57:06Z

Resolved by #79422

DSNortsev force-pushed the touch_fix_new branch from 7fd940f to da63e6d Compare July 20, 2019 22:17

DSNortsev force-pushed the touch_fix_new branch from ee54083 to 73ef879 Compare July 21, 2019 16:53

Andersson007 reviewed Jul 22, 2019

View reviewed changes

bcoca added P3 Priority 3 - Approved, No Time Limitation and removed needs_triage Needs a first human triage before being processed. labels Jul 23, 2019

DSNortsev force-pushed the touch_fix_new branch from 73ef879 to 4243f2a Compare July 31, 2019 02:07

ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jul 31, 2019

DSNortsev force-pushed the touch_fix_new branch 2 times, most recently from 8bbe9b9 to 52b3bee Compare August 1, 2019 01:52

ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Aug 1, 2019

jamescassell approved these changes Aug 1, 2019

View reviewed changes

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Aug 9, 2019

Dmitry Nortsev and others added 2 commits August 13, 2019 04:14

Add integration test to test touch in check mode

e91a6c3

DSNortsev added 2 commits August 13, 2019 04:14

Fix cosmetic issues

0574155

Add future module to unittets

c1241d9

DSNortsev force-pushed the touch_fix_new branch from 52b3bee to c1241d9 Compare August 13, 2019 03:17

ansibot removed the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Aug 13, 2019

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Aug 29, 2019

Akasurde requested a review from s-hertel June 18, 2020 08:27

s-hertel reviewed Jun 19, 2020

View reviewed changes

ansibot added pre_azp This PR was last tested before migration to Azure Pipelines. and removed stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Dec 4, 2020

ansibot removed the support:community This issue/PR relates to code supported by the Ansible community. label Mar 5, 2021

sivel closed this Nov 30, 2022

ansible locked and limited conversation to collaborators Dec 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix changes status and return diff information when state=touch and c… #59341

Fix changes status and return diff information when state=touch and c… #59341

DSNortsev commented Jul 20, 2019 •

edited

DSNortsev commented Jul 20, 2019

DSNortsev commented Jul 21, 2019 •

edited

Andersson007 left a comment

Andersson007 Jul 22, 2019

Andersson007 Jul 22, 2019

Andersson007 Jul 22, 2019

Andersson007 Jul 22, 2019

Andersson007 Jul 22, 2019

ansibot commented Jul 31, 2019

Akasurde commented Jun 18, 2020

s-hertel left a comment

s-hertel Jun 19, 2020

s-hertel Jun 19, 2020

s-hertel Jun 19, 2020

Andersson007 commented Jul 21, 2020

sivel commented Nov 30, 2022


		- name: verify touch updates only mtime when atime is preserved
		file: path={{output_dir}}/foo.txt state=touch access_time=preserve


		- name: verify touch updated only atime when mtime is preserved
		file: path={{output_dir}}/foo.txt state=touch modification_time=preserve

		@@ -0,0 +1,2 @@
		bugfixes:
		- file - Fix changed status and return diff information in file module when state=touch and check mode is set https://github.com/ansible/ansible/issues/50452

	elif module.params['access_time'] != 'preserve' or module.params['modification_time'] != 'preserve':
	else:

	result['diff'] = diff
	result['diff'] = diff
	result['changed'] = True

Fix changes status and return diff information when state=touch and c… #59341

Fix changes status and return diff information when state=touch and c… #59341

Conversation

DSNortsev commented Jul 20, 2019 • edited

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

DSNortsev commented Jul 20, 2019

DSNortsev commented Jul 21, 2019 • edited

Andersson007 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ansibot commented Jul 31, 2019

Akasurde commented Jun 18, 2020

s-hertel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Andersson007 commented Jul 21, 2020

sivel commented Nov 30, 2022

DSNortsev commented Jul 20, 2019 •

edited

DSNortsev commented Jul 21, 2019 •

edited