Skip to content

DeleteFileAction: New action for DuplicateFileBear #2947

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.

Sign up for GitHub

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

Open
akshatkarani wants to merge 2 commits into
base: master
Choose a base branch
from
Open

DeleteFileAction: New action for DuplicateFileBear #2947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf25a18
DuplicateFileBear.py: Remove file argument
akshatkarani Aug 9, 2019
ad966a3
DeleteFileAction: New action for DuplicateFileBear
akshatkarani Aug 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions bears/general/DuplicateFileBear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from coalib.bears.GlobalBear import GlobalBear
from coalib.results.Result import Result
from coalib.results.RESULT_SEVERITY import RESULT_SEVERITY
from bears.general.actions.DeleteFileAction import DeleteFileAction


class DuplicateFileBear(GlobalBear):
Expand Down Expand Up @@ -33,6 +34,8 @@ def run(self):
second_file_name = file_pair[1]
message = ('File ' + first_file_name + ' is identical'
' to File ' + second_file_name)
yield Result.from_values(origin=self, message=message,
severity=RESULT_SEVERITY.INFO,
file=first_file_name)
yield Result(origin=self,
message=message,
severity=RESULT_SEVERITY.INFO,
actions=[DeleteFileAction(first_file_name),
DeleteFileAction(second_file_name)])
26 changes: 26 additions & 0 deletions bears/general/actions/DeleteFileAction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import os
from coalib.results.result_actions.ResultAction import ResultAction


class DeleteFileAction(ResultAction):
"""
Deletes a file
"""

SUCCESS_MESSAGE = 'File deleted successfully.'

def __init__(self, filename):
self.filename = filename
self.description = ('Delete {} [Note: This will '
'delete the file permanently]').format(filename)

@staticmethod
def is_applicable(result,
original_file_dict,
file_diff_dict,
applied_actions=()):
return 'DeleteFileAction' not in applied_actions

def apply(self, result, original_file_dict, file_diff_dict):
os.remove(self.filename)
return file_diff_dict
Empty file added bears/general/actions/__init__.py
View file
Open in desktop
Empty file.
35 changes: 35 additions & 0 deletions tests/general/actions/DeleteFileActionTest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import os
import unittest
from unittest.mock import patch
from coalib.results.Result import Result
from bears.general.actions.DeleteFileAction import DeleteFileAction
from coala_utils.ContextManagers import retrieve_stdout


def get_path(file):
return os.path.join(
os.getcwd(), 'tests', 'general', 'duplicate_test_files', file)


class DeleteFileActionTest(unittest.TestCase):

def setUp(self):
self.file1 = 'complexFirst.txt'
self.file2 = 'complexSecond.txt'
self.result = Result('origin', 'message')
self.uut1 = DeleteFileAction(self.file1)
self.uut2 = DeleteFileAction(self.file2)

def test_is_applicable(self):
self.assertTrue(self.uut1.is_applicable(self.result, {}, {}))
self.assertFalse(self.uut1.is_applicable(
self.result, {}, {}, applied_actions=('DeleteFileAction')))

def test_apply(self):
with retrieve_stdout() as stdout:
patcher = ('bears.general.actions.DeleteFileAction.'
'os.remove')
with patch(patcher):
ret = self.uut1.apply(self.result, {}, {'file': 'diff'})
self.assertEqual(ret, {'file': 'diff'})
self.assertEqual(stdout.getvalue(), '')
Empty file added tests/general/actions/__init__.py
View file
Open in desktop
Empty file.