Expose build failure reason

We can use this to show more informative error messages with
links to documentation etc.

2 files changed, 12 insertions, 0 deletions

diff --git a/app/serializers/build_details_entity.rb b/app/serializers/build_details_entity.rb
index 9ddce0d2c80..62c26809eeb 100644
--- a/app/serializers/build_details_entity.rb
+++ b/app/serializers/build_details_entity.rb
@@ -45,6 +45,8 @@ class BuildDetailsEntity < JobEntity
     erase_project_job_path(project, build)
   end
 
+  expose :failure_reason, if: -> (*) { build.failed? }
+
   expose :terminal_path, if: -> (*) { can_create_build_terminal? } do |build|
     terminal_project_job_path(project, build)
   end
diff --git a/spec/serializers/build_details_entity_spec.rb b/spec/serializers/build_details_entity_spec.rb
index f6bd6e9ede4..1edf69dc290 100644
--- a/spec/serializers/build_details_entity_spec.rb
+++ b/spec/serializers/build_details_entity_spec.rb
@@ -112,5 +112,15 @@ describe BuildDetailsEntity do
         expect(subject['merge_request_path']).to be_nil
       end
     end
+
+    context 'when the build has failed' do
+      let(:build) { create(:ci_build, :created) }
+
+      before do
+        build.drop!(:unmet_prerequisites)
+      end
+
+      it { is_expected.to include(failure_reason: 'unmet_prerequisites') }
+    end
   end
 end