text: # -*- coding: utf-8 -*-
  #
  # Copyright 2012-2015 Spotify AB
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  # http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  #
  
  import sys
  
  import luigi
  import luigi.date_interval
  import luigi.notifications
  from luigi.interface import _WorkerSchedulerFactory
  from luigi.worker import Worker
  from luigi.interface import core
  from luigi.execution_summary import LuigiStatusCode
  
  from mock import Mock, patch, MagicMock
  from helpers import LuigiTestCase, with_config
  
  luigi.notifications.DEBUG = True
  
  
  class InterfaceTest(LuigiTestCase):
  
      def setUp(self):
          self.worker = Worker()
  
          self.worker_scheduler_factory = _WorkerSchedulerFactory()
          self.worker_scheduler_factory.create_worker = Mock(return_value=self.worker)
          self.worker_scheduler_factory.create_local_scheduler = Mock()
          super(InterfaceTest, self).setUp()
  
          class NoOpTask(luigi.Task):
              param = luigi.Parameter()
  
          self.task_a = NoOpTask("a")
          self.task_b = NoOpTask("b")
  
      def _create_summary_dict_with(self, updates={}):
          summary_dict = {
              'completed': set(),
              'already_done': set(),
              'ever_failed': set(),
              'failed': set(),
              'scheduling_error': set(),
              'still_pending_ext': set(),
              'still_pending_not_ext': set(),
              'run_by_other_worker': set(),
              'upstream_failure': set(),
              'upstream_missing_dependency': set(),
              'upstream_run_by_other_worker': set(),
              'upstream_scheduling_error': set(),
              'not_run': set()
          }
          summary_dict.update(updates)
          return summary_dict
  
      def _summary_dict_module_path():
          return 'luigi.execution_summary._summary_dict'
  
      def test_interface_run_positive_path(self):
          self.worker.add = Mock(side_effect=[True, True])
          self.worker.run = Mock(return_value=True)
          self.assertTrue(self._run_interface())
  
      def test_interface_run_positive_path_with_detailed_summary_enabled(self):
          self.worker.add = Mock(side_effect=[True, True])
          self.worker.run = Mock(return_value=True)
          self.assertTrue(self._run_interface(detailed_summary=True).scheduling_succeeded)
  
      def test_interface_run_with_add_failure(self):
          self.worker.add = Mock(side_effect=[True, False])
          self.worker.run = Mock(return_value=True)
          self.assertFalse(self._run_interface())
  
      def test_interface_run_with_add_failure_with_detailed_summary_enabled(self):
          self.worker.add = Mock(side_effect=[True, False])
          self.worker.run = Mock(return_value=True)
          self.assertFalse(self._run_interface(detailed_summary=True).scheduling_succeeded)
  
      def test_interface_run_with_run_failure(self):
          self.worker.add = Mock(side_effect=[True, True])
          self.worker.run = Mock(return_value=False)
          self.assertFalse(self._run_interface())
  
      def test_interface_run_with_run_failure_with_detailed_summary_enabled(self):
          self.worker.add = Mock(side_effect=[True, True])
          self.worker.run = Mock(return_value=False)
          self.assertFalse(self._run_interface(detailed_summary=True).scheduling_succeeded)
  
      @patch(_summary_dict_module_path())
      def test_that_status_is_success(self, fake_summary_dict):
          # Nothing in failed tasks so, should succeed
          fake_summary_dict.return_value = self._create_summary_dict_with()
          luigi_run_result = self._run_interface(detailed_summary=True)
          self.assertEqual(luigi_run_result.status, LuigiStatusCode.SUCCESS)
  
      @patch(_summary_dict_module_path())
      def test_that_status_is_success_with_retry(self, fake_summary_dict):
          # Nothing in failed tasks (only an entry in ever_failed) so, should succeed with retry
          fake_summary_dict.return_value = self._create_summary_dict_with({
              'ever_failed': [self.task_a]
          })
          luigi_run_result = self._run_interface(detailed_summary=True)
          self.assertEqual(luigi_run_result.status, LuigiStatusCode.SUCCESS_WITH_RETRY)
  
      @patch(_summary_dict_module_path())
      def test_that_status_is_failed_when_there_is_one_failed_task(self, fake_summary_dict):
          # Should fail because a task failed
          fake_summary_dict.return_value = self._create_summary_dict_with({
              'ever_failed': [self.task_a],
              'failed': [self.task_a]
          })
          luigi_run_result = self._run_interface(detailed_summary=True)
          self.assertEqual(luigi_run_result.status, LuigiStatusCode.FAILED)
  
      @patch(_summary_dict_module_path())
      def test_that_status_is_failed_with_scheduling_failure(self, fake_summary_dict):
          # Failed task and also a scheduling error
          fake_summary_dict.return_value = self._create_summary_dict_with({
              'ever_failed': [self.task_a],
              'failed': [self.task_a],
              'scheduling_error': [self.task_b]
          })
          luigi_run_result = self._run_interface(detailed_summary=True)
          self.assertEqual(luigi_run_result.status, LuigiStatusCode.FAILED_AND_SCHEDULING_FAILED)
  
      @patch(_summary_dict_module_path())
      def test_that_status_is_scheduling_failed_with_one_scheduling_error(self, fake_summary_dict):
          # Scheduling error for at least one task
          fake_summary_dict.return_value = self._create_summary_dict_with({
              'scheduling_error': [self.task_b]
          })
          luigi_run_result = self._run_interface(detailed_summary=True)
          self.assertEqual(luigi_run_result.status, LuigiStatusCode.SCHEDULING_FAILED)
  
      @patch(_summary_dict_module_path())
      def test_that_status_is_not_run_with_one_task_not_run(self, fake_summary_dict):
          # At least one of the tasks was not run
          fake_summary_dict.return_value = self._create_summary_dict_with({
              'not_run': [self.task_a]
          })
          luigi_run_result = self._run_interface(detailed_summary=True)
          self.assertEqual(luigi_run_result.status, LuigiStatusCode.NOT_RUN)
  
      @patch(_summary_dict_module_path())
      def test_that_status_is_missing_ext_with_one_task_with_missing_external_dependency(self, fake_summary_dict):
          # Missing external dependency for at least one task
          fake_summary_dict.return_value = self._create_summary_dict_with({
              'still_pending_ext': [self.task_a]
          })
          luigi_run_result = self._run_interface(detailed_summary=True)
          self.assertEqual(luigi_run_result.status, LuigiStatusCode.MISSING_EXT)
  
      def test_stops_worker_on_add_exception(self):
          worker = MagicMock()
          self.worker_scheduler_factory.create_worker = Mock(return_value=worker)
          worker.add = Mock(side_effect=AttributeError)
  
          self.assertRaises(AttributeError, self._run_interface)
          self.assertTrue(worker.__exit__.called)
  
      def test_stops_worker_on_run_exception(self):
          worker = MagicMock()
          self.worker_scheduler_factory.create_worker = Mock(return_value=worker)
          worker.add = Mock(side_effect=[True, True])
          worker.run = Mock(side_effect=AttributeError)
  
          self.assertRaises(AttributeError, self._run_interface)
          self.assertTrue(worker.__exit__.called)
  
      def test_just_run_main_task_cls(self):
          class MyTestTask(luigi.Task):
              pass
  
          class MyOtherTestTask(luigi.Task):
              my_param = luigi.Parameter()
  
          with patch.object(sys, 'argv', ['my_module.py', '--no-lock', '--local-scheduler']):
              luigi.run(main_task_cls=MyTestTask)
  
          with patch.object(sys, 'argv', ['my_module.py', '--no-lock', '--my-param', 'my_value', '--local-scheduler']):
              luigi.run(main_task_cls=MyOtherTestTask)
  
      def test_handle_failure_when_wrapper_task_failed_by_upstream_task(self):
          result = []
  
          class FailTask(luigi.Task):
              def run(self):
                  raise Exception("Fail task")
  
          class WrapperTask(luigi.WrapperTask):
              def requires(self):
                  yield FailTask()
  
              def on_upstream_failure(self):
                  result.append(0)
  
          self.assertEqual(len(result), 0)
          with patch.object(sys, 'argv', ['my_module.py', '--no-lock', '--local-scheduler']):
              luigi.run(main_task_cls=WrapperTask)
          self.assertEqual(len(result), 1)
  
      def test_do_nothing_if_wrapper_task_success(self):
          result = []
  
          class FailTask(luigi.Task):
              def run(self):
                  pass
  
          class WrapperTask(luigi.WrapperTask):
              def requires(self):
                  yield FailTask()
  
              def on_upstream_failure(self):
                  result.append(0)
  
          self.assertEqual(len(result), 0)
          with patch.object(sys, 'argv', ['my_module.py', '--no-lock', '--local-scheduler']):
              luigi.run(main_task_cls=WrapperTask)
          self.assertEqual(len(result), 0)
  
      def _run_interface(self, **env_params):
          return luigi.interface.build(
                                      [self.task_a, self.task_b],
                                      worker_scheduler_factory=self.worker_scheduler_factory,
                                      **env_params)
  
  
  class CoreConfigTest(LuigiTestCase):
  
      @with_config({})
      def test_parallel_scheduling_processes_default(self):
          self.assertEquals(0, core().parallel_scheduling_processes)
  
      @with_config({'core': {'parallel-scheduling-processes': '1234'}})
      def test_parallel_scheduling_processes(self):
          from luigi.interface import core
          self.assertEquals(1234, core().parallel_scheduling_processes)
  