@linkup-ai/abap-ai 2.0.0

package/dist/knowledge/abap/unit-testing.md

@@ -0,0 +1,303 @@
+# ABAP Unit Testing — test classes, assertions, test doubles, RAP BO testing
+
+## Test Class Definition
+
+```abap
+CLASS ltc_order_processor DEFINITION FINAL FOR TESTING
+  DURATION SHORT RISK LEVEL HARMLESS.
+
+  PRIVATE SECTION.
+    DATA mo_cut TYPE REF TO zcl_order_processor.  " class under test
+
+    METHODS setup.
+    METHODS teardown.
+    METHODS test_create_order FOR TESTING.
+    METHODS test_invalid_customer FOR TESTING.
+    METHODS test_calculate_total FOR TESTING.
+ENDCLASS.
+
+CLASS ltc_order_processor IMPLEMENTATION.
+  METHOD setup.
+    mo_cut = NEW #( ).
+  ENDMETHOD.
+
+  METHOD teardown.
+    CLEAR mo_cut.
+  ENDMETHOD.
+
+  METHOD test_create_order.
+    DATA(lv_result) = mo_cut->create_order(
+      iv_customer = 'CUST100'
+      iv_amount   = 500 ).
+
+    cl_abap_unit_assert=>assert_not_initial( lv_result ).
+    cl_abap_unit_assert=>assert_equals( exp = 'O' act = lv_result-status ).
+  ENDMETHOD.
+
+  METHOD test_invalid_customer.
+    TRY.
+        mo_cut->create_order( iv_customer = '' iv_amount = 500 ).
+        cl_abap_unit_assert=>fail( msg = 'Expected exception' ).
+      CATCH zcx_order_error INTO DATA(lx).
+        cl_abap_unit_assert=>assert_bound( lx ).
+    ENDTRY.
+  ENDMETHOD.
+
+  METHOD test_calculate_total.
+    DATA(lv_total) = mo_cut->calculate_total(
+      it_items = VALUE #( ( price = 100 qty = 2 )
+                           ( price = 50  qty = 3 ) ) ).
+
+    cl_abap_unit_assert=>assert_equals( exp = 350 act = lv_total ).
+  ENDMETHOD.
+ENDCLASS.
+```
+
+## Assertion Methods
+
+```abap
+" Equality
+cl_abap_unit_assert=>assert_equals( exp = 'A' act = lv_status msg = 'Status should be A' ).
+
+" Not initial
+cl_abap_unit_assert=>assert_not_initial( act = lv_id ).
+
+" Initial
+cl_abap_unit_assert=>assert_initial( act = lv_error ).
+
+" Bound / not bound (references)
+cl_abap_unit_assert=>assert_bound( act = lo_ref ).
+cl_abap_unit_assert=>assert_not_bound( act = lo_ref ).
+
+" True / false
+cl_abap_unit_assert=>assert_true( act = lv_flag ).
+cl_abap_unit_assert=>assert_false( act = lv_flag ).
+
+" Table content
+cl_abap_unit_assert=>assert_equals( exp = 3 act = lines( lt_items ) ).
+
+" Subrc
+cl_abap_unit_assert=>assert_subrc( exp = 0 msg = 'SELECT should find record' ).
+
+" Fail explicitly
+cl_abap_unit_assert=>fail( msg = 'Should not reach here' ).
+
+" Char contains
+cl_abap_unit_assert=>assert_char_cp(
+  exp = '*error*' act = lv_message msg = 'Should contain error' ).
+```
+
+## Test Doubles — SQL (CDS)
+
+```abap
+" Mock database access for CDS entities
+CLASS ltc_with_sql_double DEFINITION FINAL FOR TESTING
+  DURATION SHORT RISK LEVEL HARMLESS.
+
+  PRIVATE SECTION.
+    CLASS-DATA environment TYPE REF TO if_cds_test_environment.
+
+    CLASS-METHODS class_setup.
+    CLASS-METHODS class_teardown.
+    METHODS setup.
+    METHODS test_read FOR TESTING.
+ENDCLASS.
+
+CLASS ltc_with_sql_double IMPLEMENTATION.
+  METHOD class_setup.
+    environment = cl_cds_test_environment=>create( i_for_entity = 'ZI_ORDER' ).
+  ENDMETHOD.
+
+  METHOD class_teardown.
+    environment->destroy( ).
+  ENDMETHOD.
+
+  METHOD setup.
+    environment->clear_doubles( ).
+  ENDMETHOD.
+
+  METHOD test_read.
+    " Prepare test data
+    DATA lt_orders TYPE STANDARD TABLE OF ztab_order.
+    lt_orders = VALUE #(
+      ( order_id = '0000000001' customer_id = 'CUST100' status = 'O' total_amount = 500 )
+      ( order_id = '0000000002' customer_id = 'CUST200' status = 'A' total_amount = 800 ) ).
+
+    environment->insert_test_data( lt_orders ).
+
+    " Execute code under test
+    SELECT * FROM ZI_Order INTO TABLE @DATA(lt_result).
+
+    cl_abap_unit_assert=>assert_equals( exp = 2 act = lines( lt_result ) ).
+  ENDMETHOD.
+ENDCLASS.
+```
+
+## Test Doubles — ABAP OO (Interface Mock)
+
+```abap
+" Using CL_ABAP_TESTDOUBLE
+CLASS ltc_with_mock DEFINITION FINAL FOR TESTING
+  DURATION SHORT RISK LEVEL HARMLESS.
+
+  PRIVATE SECTION.
+    METHODS test_with_mock FOR TESTING.
+ENDCLASS.
+
+CLASS ltc_with_mock IMPLEMENTATION.
+  METHOD test_with_mock.
+    " Create test double for interface
+    DATA lo_double TYPE REF TO zif_customer_service.
+    lo_double ?= cl_abap_testdouble=>create( 'zif_customer_service' ).
+
+    " Configure behavior
+    cl_abap_testdouble=>configure_call( lo_double
+      )->returning( VALUE zs_customer( id = 'C100' name = 'Test Customer' ) ).
+    lo_double->get_customer( 'C100' ).  " records the call
+
+    " Inject and test
+    DATA(lo_cut) = NEW zcl_order_processor( io_customer_svc = lo_double ).
+    DATA(ls_order) = lo_cut->create_order( iv_customer = 'C100' ).
+
+    cl_abap_unit_assert=>assert_equals( exp = 'Test Customer' act = ls_order-customer_name ).
+
+    " Verify call was made
+    cl_abap_testdouble=>verify_expectations( lo_double ).
+  ENDMETHOD.
+ENDCLASS.
+```
+
+## RAP BO Test — Managed BO with EML
+
+```abap
+CLASS ltc_travel_bo DEFINITION FINAL FOR TESTING
+  DURATION SHORT RISK LEVEL HARMLESS.
+
+  PRIVATE SECTION.
+    CLASS-DATA environment TYPE REF TO if_cds_test_environment.
+    CLASS-DATA bo_test_env TYPE REF TO if_botd_txbufdbl_bo_test_env.
+
+    CLASS-METHODS class_setup.
+    CLASS-METHODS class_teardown.
+    METHODS setup.
+    METHODS test_create_travel FOR TESTING.
+    METHODS test_accept_travel FOR TESTING.
+    METHODS test_validate_dates FOR TESTING.
+ENDCLASS.
+
+CLASS ltc_travel_bo IMPLEMENTATION.
+  METHOD class_setup.
+    " Create BO test double environment
+    bo_test_env = cl_botd_txbufdbl_bo_test_env=>create(
+      VALUE #( ( 'ZI_TRAVEL' ) ) ).
+
+    " CDS test environment for related entities
+    environment = cl_cds_test_environment=>create(
+      i_for_entity = 'ZI_TRAVEL'
+      i_dependency_list = VALUE #( ( '/DMO/I_AGENCY' ) ( '/DMO/I_CUSTOMER' ) ) ).
+  ENDMETHOD.
+
+  METHOD class_teardown.
+    bo_test_env->destroy( ).
+    environment->destroy( ).
+  ENDMETHOD.
+
+  METHOD setup.
+    environment->clear_doubles( ).
+  ENDMETHOD.
+
+  METHOD test_create_travel.
+    MODIFY ENTITIES OF ZI_Travel
+      ENTITY Travel
+      CREATE FIELDS ( AgencyID CustomerID BeginDate EndDate Description )
+      WITH VALUE #( (
+        %cid        = 'CID_1'
+        AgencyID    = '000001'
+        CustomerID  = '000001'
+        BeginDate   = sy-datum
+        EndDate     = sy-datum + 10
+        Description = 'Test Travel' ) )
+      MAPPED DATA(mapped)
+      FAILED DATA(failed)
+      REPORTED DATA(reported).
+
+    cl_abap_unit_assert=>assert_not_initial( mapped-travel ).
+    cl_abap_unit_assert=>assert_initial( failed-travel ).
+  ENDMETHOD.
+
+  METHOD test_accept_travel.
+    " First create
+    MODIFY ENTITIES OF ZI_Travel
+      ENTITY Travel
+      CREATE FIELDS ( AgencyID CustomerID BeginDate EndDate )
+      WITH VALUE #( ( %cid = 'CID_1' AgencyID = '000001' CustomerID = '000001'
+                      BeginDate = sy-datum  EndDate = sy-datum + 10 ) )
+      MAPPED DATA(mapped) FAILED DATA(failed) REPORTED DATA(reported).
+
+    " Then execute action
+    MODIFY ENTITIES OF ZI_Travel
+      ENTITY Travel
+      EXECUTE acceptTravel
+      FROM VALUE #( ( %tky = mapped-travel[ 1 ]-%tky ) )
+      RESULT DATA(result)
+      FAILED failed
+      REPORTED reported.
+
+    cl_abap_unit_assert=>assert_equals(
+      exp = 'A' act = result[ 1 ]-%param-OverallStatus ).
+  ENDMETHOD.
+
+  METHOD test_validate_dates.
+    " Create with invalid dates (end before begin)
+    MODIFY ENTITIES OF ZI_Travel
+      ENTITY Travel
+      CREATE FIELDS ( AgencyID CustomerID BeginDate EndDate )
+      WITH VALUE #( ( %cid = 'CID_1' AgencyID = '000001' CustomerID = '000001'
+                      BeginDate = '20260315'  EndDate = '20260310' ) )
+      MAPPED DATA(mapped) FAILED DATA(failed) REPORTED DATA(reported).
+
+    COMMIT ENTITIES
+      RESPONSE OF ZI_Travel
+      FAILED DATA(commit_failed)
+      REPORTED DATA(commit_reported).
+
+    " Validation should have produced error
+    cl_abap_unit_assert=>assert_not_initial( commit_failed-travel ).
+  ENDMETHOD.
+ENDCLASS.
+```
+
+## Test Class Annotations
+
+```abap
+" Duration
+DURATION SHORT     " < 1 second per method (default)
+DURATION MEDIUM    " < 5 seconds
+DURATION LONG      " > 5 seconds
+
+" Risk level
+RISK LEVEL HARMLESS    " No DB changes (default)
+RISK LEVEL DANGEROUS   " May change DB
+RISK LEVEL CRITICAL    " May change system config
+```
+
+## Rules
+- Test class: `FOR TESTING` + `DURATION SHORT` + `RISK LEVEL HARMLESS`
+- Use `setup` for per-test initialization, `class_setup` for one-time setup
+- One assertion per logical check — multiple assertions OK if testing one behavior
+- Use CDS test environment (`cl_cds_test_environment`) for SQL test doubles
+- Use `cl_abap_testdouble` for OO interface mocking
+- RAP BO tests: use `cl_botd_txbufdbl_bo_test_env` for transaction buffer doubles
+- Always `destroy()` environments in `class_teardown`
+- Test method names should describe what is tested: `test_<scenario>`
+
+## Anti-Patterns
+| Anti-Pattern | Correct |
+|---|---|
+| Testing private methods directly | Test via public interface |
+| No assertions in test method | Always assert expected outcome |
+| `CATCH cx_root` hiding test failures | Let exceptions propagate or assert them |
+| DB access in RISK LEVEL HARMLESS | Use test doubles or set RISK LEVEL DANGEROUS |
+| Missing `setup` / `class_setup` | Initialize test data properly |
+| Huge test methods testing everything | One scenario per test method |
+| Hardcoded dates that expire | Use `sy-datum` + offset |

package/dist/knowledge/abap-cds/access-control.md

@@ -0,0 +1,241 @@
+# CDS Access Control — DCL Row-Level Authorization
+
+## DCL Structure
+
+```sql
+@EndUserText.label: 'Access Control for Z_SALES'
+@MappingRole: true
+define role Z_SALES_DCL {
+  grant select on Z_SALES
+    where condition;
+}
+```
+
+## PFCG Authorization — Single Object
+
+```sql
+@MappingRole: true
+define role Z_FIN_DCL {
+  grant select on Z_FINANCIAL_DATA
+    where (bukrs) = aspect pfcg_auth(F_BKPF_BUK, BUKRS, ACTVT = '03');
+}
+```
+
+Syntax: `(cds_field) = aspect pfcg_auth(AUTH_OBJECT, AUTH_FIELD, ACTVT = 'value')`
+
+## PFCG — Multiple Fields
+
+```sql
+@MappingRole: true
+define role Z_SD_DCL {
+  grant select on Z_SALES_ORDER
+    where (vkorg, vtweg, spart) =
+      aspect pfcg_auth(V_VBAK_VKO, VKORG, VTWEG, SPART, ACTVT = '03');
+}
+```
+
+Fields map positionally to authorization fields.
+
+## PFCG — Multiple Objects
+
+```sql
+@MappingRole: true
+define role Z_MULTI_DCL {
+  grant select on Z_VIEW
+    where (bukrs) = aspect pfcg_auth(F_BKPF_BUK, BUKRS, ACTVT = '03')
+      and (vkorg, vtweg, spart) =
+          aspect pfcg_auth(V_VBAK_VKO, VKORG, VTWEG, SPART, ACTVT = '03');
+}
+```
+
+## Literal Condition
+
+```sql
+@MappingRole: true
+define role Z_ACTIVE_DCL {
+  grant select on Z_VIEW
+    where status = 'ACTIVE';
+}
+```
+
+Operators: `=`, `<>`, `<`, `>`, `<=`, `>=`, `between ... and ...`, `like`
+
+## User Aspect
+
+```sql
+@MappingRole: true
+define role Z_OWN_DCL {
+  grant select on Z_TASKS
+    where assigned_to ?= aspect user;
+}
+```
+
+`?=` allows NULL/initial values to pass.
+
+## Environment Aspect
+
+```sql
+where client = aspect environment.client
+```
+
+## Combining Conditions — AND
+
+```sql
+where (bukrs) = aspect pfcg_auth(F_BKPF_BUK, BUKRS, ACTVT = '03')
+  and status = 'ACTIVE'
+  and created_by ?= aspect user;
+```
+
+## Combining Conditions — OR
+
+```sql
+where status = 'PUBLIC'
+   or created_by ?= aspect user;
+```
+
+## Complex Logic
+
+```sql
+where (
+    (bukrs) = aspect pfcg_auth(F_BKPF_BUK, BUKRS, ACTVT = '03')
+    and status = 'ACTIVE'
+  )
+  or status = 'PUBLIC';
+```
+
+## Sales Org + Status Filter
+
+```sql
+@MappingRole: true
+define role Z_SALES_FILTER_DCL {
+  grant select on Z_SALES_ORDER
+    where (vkorg, vtweg, spart) =
+          aspect pfcg_auth(V_VBAK_VKO, VKORG, VTWEG, SPART, ACTVT = '03')
+      and status <> 'DELETED';
+}
+```
+
+## Public + Owned Records
+
+```sql
+@MappingRole: true
+define role Z_MIXED_DCL {
+  grant select on Z_DOCUMENTS
+    where visibility = 'PUBLIC'
+       or created_by ?= aspect user;
+}
+```
+
+## Multi-level Authorization
+
+```sql
+@MappingRole: true
+define role Z_MATERIAL_DCL {
+  grant select on Z_MATERIAL_DATA
+    where (werks) = aspect pfcg_auth(M_MATE_WRK, WERKS, ACTVT = '03')
+      and (mtart) = aspect pfcg_auth(M_MATE_MAR, MTART, ACTVT = '03');
+}
+```
+
+## CDS View Annotation
+
+```sql
+@AccessControl.authorizationCheck: #CHECK
+define view Z_SECURED as select from ...
+```
+
+| Value | Behavior |
+|-------|----------|
+| `#NOT_REQUIRED` | No DCL needed, full access |
+| `#CHECK` | Warning if DCL missing |
+| `#MANDATORY` | Syntax error if DCL missing |
+| `#NOT_ALLOWED` | DCL ignored |
+
+## Common Authorization Objects
+
+| Object | Fields | Domain |
+|--------|--------|--------|
+| `F_BKPF_BUK` | BUKRS, ACTVT | Company code |
+| `F_BKPF_GSB` | GSBER, ACTVT | Business area |
+| `V_VBAK_VKO` | VKORG, VTWEG, SPART, ACTVT | Sales org |
+| `V_VBAK_AAT` | AUART, ACTVT | Order type |
+| `M_MATE_WRK` | WERKS, ACTVT | Plant |
+| `M_MATE_MAR` | MTART, ACTVT | Material type |
+| `K_CCA` | KOKRS, KOSTL, ACTVT | Cost center |
+| `K_ORDER` | AUFNR, ACTVT | Internal order |
+
+## Activity Values (ACTVT)
+
+| Value | Activity |
+|-------|----------|
+| `01` | Create |
+| `02` | Change |
+| `03` | Display |
+| `06` | Delete |
+| `16` | Execute |
+
+Most CDS views use `ACTVT = '03'`.
+
+## ABAP — Bypass Check
+
+```abap
+" DCL automatically applied
+SELECT * FROM z_secured INTO TABLE @DATA(lt_data).
+
+" BYPASSING BUFFER does NOT bypass DCL
+" There is no way to bypass DCL from ABAP
+```
+
+## Full Example — Sales Order DCL
+
+```sql
+@EndUserText.label: 'Sales Order Access Control'
+@MappingRole: true
+define role Z_SO_FULL_DCL {
+  grant select on Z_SALES_ORDER
+    where (vkorg, vtweg, spart) =
+          aspect pfcg_auth(V_VBAK_VKO, VKORG, VTWEG, SPART, ACTVT = '03')
+      and (bukrs) = aspect pfcg_auth(F_BKPF_BUK, BUKRS, ACTVT = '03')
+      and status <> 'DELETED';
+}
+```
+
+## Hierarchy Pattern — Consistent DCL
+
+```sql
+-- Interface view
+@MappingRole: true
+define role Z_I_SO_DCL {
+  grant select on Z_I_SALES_ORDER
+    where (bukrs) = aspect pfcg_auth(F_BKPF_BUK, BUKRS, ACTVT = '03');
+}
+
+-- Consumption view (same auth, different entity)
+@MappingRole: true
+define role Z_C_SO_DCL {
+  grant select on Z_C_SALES_ORDER
+    where (bukrs) = aspect pfcg_auth(F_BKPF_BUK, BUKRS, ACTVT = '03');
+}
+```
+
+## Rules
+
+- `@MappingRole: true` is required on every DCL role
+- DCL does NOT inherit to consuming views — each view needs its own DCL
+- Use `?=` (optional operator) for fields that may be NULL/initial
+- Most CDS views use ACTVT = '03' (display)
+- Use `#CHECK` or `#MANDATORY` on sensitive views
+- Create DCL for all views in a hierarchy, not just the base
+- Find auth objects in SU21, test with SU53
+
+## Anti-Patterns
+
+| Anti-Pattern | Correct |
+|---|---|
+| `#NOT_REQUIRED` on sensitive data | Use `#CHECK` or `#MANDATORY` |
+| Assuming DCL inheritance from base view | Create DCL per view in chain |
+| Using `=` instead of `?=` when field can be NULL | Use `?=` for nullable fields |
+| Missing `@MappingRole: true` | Always add — required for role mapping |
+| Complex OR chains without parentheses | Use explicit parentheses for logic clarity |
+| Relying only on app-level auth checks | Add DCL as defense in depth |
+| Using ACTVT = '02' for read-only views | Use ACTVT = '03' for display |