Block commit/push if code inspection has errors

- new local setting to set check variant
- new local setting to block pull if code inspector check fails
- check is executed before staging
- new page to display code inspector results

src/persist/zif_abapgit_persistence.intf.abap

@@ -20,9 +20,11 @@ INTERFACE zif_abapgit_persistence PUBLIC.
 
   TYPES:
     BEGIN OF ty_local_settings,
-      ignore_subpackages TYPE abap_bool,
-      write_protected    TYPE abap_bool,
-      only_local_objects TYPE abap_bool,
+      ignore_subpackages           TYPE abap_bool,
+      write_protected              TYPE abap_bool,
+      only_local_objects           TYPE abap_bool,
+      code_inspector_check_variant TYPE sci_chkv ,
+      block_commit                 TYPE abap_bool,
     END OF ty_local_settings.
 
   TYPES: ty_local_checksum_tt TYPE STANDARD TABLE OF ty_local_checksum WITH DEFAULT KEY.

src/ui/zcl_abapgit_gui_page_code_insp.clas.abap

@@ -0,0 +1,271 @@
+CLASS zcl_abapgit_gui_page_code_insp DEFINITION PUBLIC FINAL CREATE PUBLIC
+    INHERITING FROM zcl_abapgit_gui_page.
+
+  PUBLIC SECTION.
+    METHODS:
+      constructor
+        IMPORTING
+          io_repo TYPE REF TO zcl_abapgit_repo
+        RAISING
+          zcx_abapgit_exception,
+
+      zif_abapgit_gui_page~on_event
+        REDEFINITION,
+
+      zif_abapgit_gui_page~render
+        REDEFINITION.
+
+
+  PROTECTED SECTION.
+    DATA: mo_repo TYPE REF TO zcl_abapgit_repo_online.
+
+    METHODS:
+      render_content REDEFINITION.
+
+  PRIVATE SECTION.
+    CONSTANTS:
+      BEGIN OF c_actions,
+        stage TYPE string VALUE 'stage' ##NO_TEXT,
+        rerun TYPE string VALUE 'rerun' ##NO_TEXT,
+      END OF c_actions.
+
+    DATA:
+      mt_result TYPE scit_alvlist.
+
+    METHODS:
+      build_menu
+        RETURNING
+          VALUE(ro_menu) TYPE REF TO zcl_abapgit_html_toolbar,
+
+      run_code_inspector
+        RAISING
+          zcx_abapgit_exception,
+
+      has_inspection_errors
+        RETURNING
+          VALUE(rv_has_inspection_errors) TYPE abap_bool,
+
+      is_stage_allowed
+        RETURNING
+          VALUE(rv_is_stage_allowed) TYPE abap_bool,
+      jump
+        IMPORTING
+          is_item TYPE zif_abapgit_definitions=>ty_item
+        RAISING
+          zcx_abapgit_exception.
+
+ENDCLASS.
+
+
+
+CLASS zcl_abapgit_gui_page_code_insp IMPLEMENTATION.
+
+
+  METHOD build_menu.
+
+    DATA: lv_opt TYPE c LENGTH 1.
+
+    CREATE OBJECT ro_menu.
+
+    ro_menu->add( iv_txt = 'Re-Run'
+                  iv_act = c_actions-rerun
+                  iv_cur = abap_false ) ##NO_TEXT.
+
+    IF is_stage_allowed( ) = abap_false.
+      lv_opt = zif_abapgit_definitions=>gc_html_opt-crossout.
+    ENDIF.
+
+    ro_menu->add( iv_txt = 'Stage'
+                  iv_act = c_actions-stage
+                  iv_cur = abap_false
+                  iv_opt = lv_opt ) ##NO_TEXT.
+
+  ENDMETHOD.
+
+
+  METHOD constructor.
+    super->constructor( ).
+    mo_repo ?= io_repo.
+    ms_control-page_title = 'Code Inspector'.
+    run_code_inspector( ).
+  ENDMETHOD.  " constructor.
+
+
+  METHOD has_inspection_errors.
+
+    READ TABLE mt_result TRANSPORTING NO FIELDS
+                         WITH KEY kind = 'E'.
+    rv_has_inspection_errors = boolc( sy-subrc = 0 ).
+
+  ENDMETHOD.
+
+
+  METHOD is_stage_allowed.
+
+    rv_is_stage_allowed =  boolc( NOT ( mo_repo->get_local_settings( )-block_commit = abap_true
+                                           AND has_inspection_errors( ) = abap_true ) ).
+
+  ENDMETHOD.
+
+
+  METHOD render_content.
+
+    DATA: lv_check_variant TYPE sci_chkv,
+          lv_class         TYPE string.
+    FIELD-SYMBOLS: <ls_result> TYPE scir_alvlist.
+
+    CREATE OBJECT ro_html.
+
+    lv_check_variant = mo_repo->get_local_settings( )-code_inspector_check_variant.
+
+    IF lv_check_variant IS INITIAL.
+      ro_html->add( |No check variant maintained in repo settings.| ).
+      RETURN.
+    ENDIF.
+
+    ro_html->add( '<div class="toc"><br/>' ).
+
+    ro_html->add( |Code inspector check variant: {
+                    mo_repo->get_local_settings( )-code_inspector_check_variant
+                  }<br/>| ).
+
+    IF lines( mt_result ) = 0.
+      ro_html->add( '<br/><div class="success">No code inspector findings</div>' ).
+    ENDIF.
+
+    ro_html->add( |<br/>| ).
+
+    LOOP AT mt_result ASSIGNING <ls_result>.
+
+      ro_html->add( '<div>' ).
+      ro_html->add_a( iv_txt = |{ <ls_result>-objtype } { <ls_result>-objname }|
+                      iv_act = |{ <ls_result>-objtype }{ <ls_result>-objname }|
+                      iv_typ = zif_abapgit_definitions=>gc_action_type-sapevent ).
+      ro_html->add( '</div>' ).
+
+      CASE <ls_result>-kind.
+        WHEN 'E'.
+          lv_class = 'error'.
+        WHEN 'W'.
+          lv_class = 'warning'.
+        WHEN OTHERS.
+          lv_class = 'grey'.
+      ENDCASE.
+
+      ro_html->add( |<div class="{ lv_class }">Line { <ls_result>-line ALPHA = OUT }: { <ls_result>-text }</div><br>| ).
+    ENDLOOP.
+
+    ro_html->add( '</div>' ).
+
+  ENDMETHOD.  "render_content
+
+
+  METHOD run_code_inspector.
+
+    mt_result = mo_repo->run_code_inspector( ).
+
+  ENDMETHOD.
+
+
+  METHOD zif_abapgit_gui_page~on_event.
+
+    DATA: lo_repo_online TYPE REF TO zcl_abapgit_repo_online,
+          ls_item        TYPE zif_abapgit_definitions=>ty_item.
+
+    lo_repo_online ?= mo_repo.
+
+    CASE iv_action.
+      WHEN c_actions-stage.
+
+        IF is_stage_allowed( ) = abap_true.
+
+          " we need to refresh as the source might have changed
+          lo_repo_online->refresh( ).
+
+          CREATE OBJECT ei_page TYPE zcl_abapgit_gui_page_stage
+            EXPORTING
+              io_repo = lo_repo_online.
+
+          ev_state = zif_abapgit_definitions=>gc_event_state-new_page.
+
+        ELSE.
+
+          ei_page = me.
+          ev_state = zif_abapgit_definitions=>gc_event_state-no_more_act.
+
+        ENDIF.
+
+      WHEN c_actions-rerun.
+
+        run_code_inspector( ).
+
+        ei_page = me.
+        ev_state = zif_abapgit_definitions=>gc_event_state-re_render.
+
+      WHEN OTHERS.
+
+        ls_item-obj_type = iv_action(4).
+        ls_item-obj_name = iv_action+4(*).
+
+        jump( ls_item ).
+
+*        zcl_abapgit_objects=>jump( ls_item ).
+
+        ev_state = zif_abapgit_definitions=>gc_event_state-no_more_act.
+
+    ENDCASE.
+
+  ENDMETHOD.
+
+
+  METHOD zif_abapgit_gui_page~render.
+
+    ms_control-page_menu = build_menu( ).
+    ro_html = super->zif_abapgit_gui_page~render( ).
+
+  ENDMETHOD.
+
+
+  METHOD jump.
+
+    DATA: lo_test               TYPE REF TO cl_ci_test_root,
+          li_code_inspector     TYPE REF TO zif_abapgit_code_inspector,
+          ls_info               TYPE scir_rest,
+          lo_result             TYPE REF TO cl_ci_result_root,
+          lv_check_variant_name TYPE sci_chkv,
+          lv_package            TYPE devclass,
+          lv_srcid              TYPE scr_source_id.
+
+    FIELD-SYMBOLS: <ls_result> TYPE scir_alvlist.
+
+    READ TABLE mt_result WITH KEY objtype = is_item-obj_type
+                                  objname = is_item-obj_name
+                         ASSIGNING <ls_result>.
+    ASSERT sy-subrc = 0.
+
+    lv_package = mo_repo->get_package( ).
+    lv_check_variant_name = mo_repo->get_local_settings( )-code_inspector_check_variant.
+
+    li_code_inspector = zcl_abapgit_factory=>get_code_inspector(
+        iv_package            = lv_package
+        iv_check_variant_name = lv_check_variant_name ).
+
+    " see SCI_LCL_DYNP_530 / HANDLE_DOUBLE_CLICK
+
+    MOVE-CORRESPONDING <ls_result> TO ls_info.
+
+    lo_test = cl_ci_tests=>get_test_ref( <ls_result>-test ).
+    lo_result = lo_test->get_result_node( <ls_result>-kind ).
+
+    lv_srcid = li_code_inspector->get_inspection( )->objs->objectsinf-srcid.
+
+    lo_result->set_srcid(
+        p_info  = ls_info
+        p_srcid = lv_srcid ).
+
+    lo_result->set_info( ls_info ).
+    lo_result->if_ci_test~navigate( ).
+
+  ENDMETHOD.
+
+ENDCLASS.

src/ui/zcl_abapgit_gui_page_code_insp.clas.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8"?>
+<abapGit version="v1.0.0" serializer="LCL_OBJECT_CLAS" serializer_version="v1.0.0">
+ <asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
+  <asx:values>
+   <VSEOCLASS>
+    <CLSNAME>ZCL_ABAPGIT_GUI_PAGE_CODE_INSP</CLSNAME>
+    <VERSION>1</VERSION>
+    <LANGU>E</LANGU>
+    <DESCRIPT>GUI - Syntax check page</DESCRIPT>
+    <EXPOSURE>2</EXPOSURE>
+    <STATE>1</STATE>
+    <CLSFINAL>X</CLSFINAL>
+    <CLSCCINCL>X</CLSCCINCL>
+    <FIXPT>X</FIXPT>
+    <UNICODE>X</UNICODE>
+   </VSEOCLASS>
+  </asx:values>
+ </asx:abap>
+</abapGit>

src/ui/zcl_abapgit_gui_page_repo_sett.clas.abap

@@ -45,12 +45,14 @@ CLASS zcl_abapgit_gui_page_repo_sett DEFINITION
 
     METHODS render_content
         REDEFINITION .
+
   PRIVATE SECTION.
+
 ENDCLASS.
 
 
 
-CLASS ZCL_ABAPGIT_GUI_PAGE_REPO_SETT IMPLEMENTATION.
+CLASS zcl_abapgit_gui_page_repo_sett IMPLEMENTATION.
 
 
   METHOD constructor.
@@ -137,6 +139,7 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_REPO_SETT IMPLEMENTATION.
           ls_settings TYPE zif_abapgit_persistence=>ty_repo-local_settings.
 
 
+
     ls_settings = mo_repo->get_local_settings( ).
 
     io_html->add( '<h2>Local settings</h2>' ).
@@ -159,6 +162,19 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_REPO_SETT IMPLEMENTATION.
     ENDIF.
     io_html->add( |Only local objects <input name="only_local_objects" type="checkbox"{ lv_checked }><br>| ).
 
+    io_html->add( '<br>' ).
+    io_html->add( 'Code inspector check variant: <input name="check_variant" type="text" size="30" value="' &&
+      ls_settings-code_inspector_check_variant && '">' ).
+    io_html->add( '<br>' ).
+
+    CLEAR lv_checked.
+    IF ls_settings-block_commit = abap_true.
+      lv_checked = | checked|.
+    ENDIF.
+    io_html->add( |Block commit commit/push if code inspection has erros: |
+               && |<input name="block_commit" type="checkbox"{ lv_checked }><br>| ).
+
+
   ENDMETHOD.
 
 
@@ -200,8 +216,9 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_REPO_SETT IMPLEMENTATION.
 
   METHOD save_local_settings.
 
-    DATA: ls_settings   TYPE zif_abapgit_persistence=>ty_repo-local_settings,
-          ls_post_field LIKE LINE OF it_post_fields.
+    DATA: ls_settings      TYPE zif_abapgit_persistence=>ty_repo-local_settings,
+          ls_post_field    LIKE LINE OF it_post_fields,
+          lv_check_variant TYPE sci_chkv.
 
 
     ls_settings = mo_repo->get_local_settings( ).
@@ -227,6 +244,26 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_REPO_SETT IMPLEMENTATION.
       ls_settings-only_local_objects = abap_false.
     ENDIF.
 
+    READ TABLE it_post_fields INTO ls_post_field WITH KEY name = 'check_variant'.
+    ASSERT sy-subrc = 0.
+    lv_check_variant = to_upper( ls_post_field-value ).
+    IF ls_post_field-value IS NOT INITIAL.
+      zcl_abapgit_code_inspector=>validate_check_variant( lv_check_variant ).
+    ENDIF.
+    ls_settings-code_inspector_check_variant = lv_check_variant.
+
+    READ TABLE it_post_fields INTO ls_post_field WITH KEY name = 'block_commit' value = 'on'.
+    IF sy-subrc = 0.
+      ls_settings-block_commit = abap_true.
+    ELSE.
+      ls_settings-block_commit = abap_false.
+    ENDIF.
+
+    IF  ls_settings-block_commit = abap_true
+    AND ls_settings-code_inspector_check_variant IS INITIAL.
+      zcx_abapgit_exception=>raise( |If block commit is active, a check variant has to be maintained.| ).
+    ENDIF.
+
     mo_repo->set_local_settings( ls_settings ).
 
   ENDMETHOD.
@@ -241,4 +278,6 @@ CLASS ZCL_ABAPGIT_GUI_PAGE_REPO_SETT IMPLEMENTATION.
     ENDCASE.
 
   ENDMETHOD.
+
+
 ENDCLASS.