Use record_as_success instead of force_success

We need the real exit_code for some command since there are decisions
based on that code, but we want to record it as success.

So, the fake exit_code is saved in the database but the real exit_code
is used in the whole flow of the building process.

Author: humitos

readthedocs/doc_builder/environments.py

@@ -73,7 +73,7 @@ class BuildCommand(BuildCommandResultMixin):
 
     def __init__(self, command, cwd=None, shell=False, environment=None,
                  combine_output=True, input_data=None, build_env=None,
-                 bin_path=None, description=None):
+                 bin_path=None, description=None, record_as_success=False):
         self.command = command
         self.shell = shell
         if cwd is None:
@@ -96,6 +96,7 @@ def __init__(self, command, cwd=None, shell=False, environment=None,
         self.description = ''
         if description is not None:
             self.description = description
+        self.record_as_success = record_as_success
         self.exit_code = None
 
     def __str__(self):
@@ -183,12 +184,21 @@ def get_command(self):
 
     def save(self):
         """Save this command and result via the API."""
+        exit_code = self.exit_code
+
+        # Force record this command as success to avoid Build reporting errors
+        # on commands that are just for checking purposes and do not interferes
+        # in the Build
+        if self.record_as_success:
+            log.warning('Recording command exit_code as success')
+            exit_code = 0
+
         data = {
             'build': self.build_env.build.get('id'),
             'command': self.get_command(),
             'description': self.description,
             'output': self.output,
-            'exit_code': self.exit_code,
+            'exit_code': exit_code,
             'start_time': self.start_time,
             'end_time': self.end_time,
         }
@@ -300,8 +310,8 @@ def run(self, *cmd, **kwargs):
         return self.run_command_class(cls=self.command_class, cmd=cmd, **kwargs)
 
     def run_command_class(
-            self, cls, cmd, record=None, warn_only=False, force_success=False,
-            **kwargs):
+            self, cls, cmd, record=None, warn_only=False,
+            record_as_success=False, **kwargs):
         """
         Run command from this environment.
 
@@ -310,16 +320,22 @@ def run_command_class(
         :param record: whether or not to record this particular command
             (``False`` implies ``warn_only=True``)
         :param warn_only: don't raise an exception on command failure
-        :param force_success: force command ``exit_code`` to be saved as ``0``
-            (``True`` implies ``warn_only=True``)
+        :param record_as_success: force command ``exit_code`` to be saved as
+            ``0`` (``True`` implies ``warn_only=True`` and ``record=True``)
         """
         if record is None:
             # ``self.record`` only exists when called from ``*BuildEnvironment``
             record = getattr(self, 'record', False)
 
-        if not record or force_success:
+        if not record:
             warn_only = True
 
+        if record_as_success:
+            record = True
+            warn_only = True
+            # ``record_as_success`` is needed to instantiate the BuildCommand
+            kwargs.update({'record_as_success': record_as_success})
+
         # Remove PATH from env, and set it to bin_path if it isn't passed in
         env_path = self.environment.pop('BIN_PATH', None)
         if 'bin_path' not in kwargs and env_path:
@@ -340,10 +356,6 @@ def run_command_class(
             self.record_command(build_cmd)
 
         if build_cmd.failed:
-            if force_success:
-                self._log_warning('Forcing command to exit gracefully (exit_code = 0)')
-                build_cmd.exit_code = 0
-
             msg = u'Command {cmd} failed'.format(cmd=build_cmd.get_command())
 
             if build_cmd.output:
@@ -445,8 +457,7 @@ def handle_exception(self, exc_type, exc_value, _):
             return True
 
     def record_command(self, command):
-        if self.record:
-            command.save()
+        command.save()
 
     def _log_warning(self, msg):
         # :'(