Writing quality rules¶

<category name="MyCompany_COBOL_Rules" rid="0">
    <description></description>
    <!-- add new properties here, one for each quality rule -->

    <property name="paragraphRedefinition" type="integer" merge="sum" rid="0">
        <description>Redefinition of paragraph</description>
        <attribute name="ACCESS_APPVIEW" intValue="1"/>
        <attribute name="ACCESS_CVS" intValue="1"/>
        <attribute name="ACCESS_HTML" intValue="1"/>
        <attribute name="INF_TYPE" intValue="2001000"/>
        <attribute name="INF_SUB_TYPE" intValue="0"/>
    </property>

</category>

CREATE OR REPLACE FUNCTION DIAG_SCOPE_COBDOC004 (
        I_SNAPSHOT_ID INT,              -- the metric snapshot id
        I_METRIC_PARENT_ID INT, -- the metric parent id
        I_METRIC_ID INT,                        -- the metric id
        I_METRIC_CHILD_ID INT
)
returns INT
as
$body$
declare
           ERRORCODE    INT:=0;
Begin

--<<NAME>>DIAG_SCOPE_COBDOC004<</NAME>>
--<<COMMENT>> Template name   = UNDOCUMENTED. <</COMMENT>>
--<<COMMENT>> Diagnostic name = Avoid undocumented Programs. <</COMMENT>>
--<<COMMENT>> Definition      = Avoid undocumented Programs. <</COMMENT>>
--<<COMMENT>> Action          = Lists all Programs that have neither heading comments nor inline comments. <</COMMENT>>
--<<COMMENT>> Value           = 1. <</COMMENT>>

  insert into DSS_METRIC_SCOPES
        (OBJECT_ID, METRIC_PARENT_ID, METRIC_ID, OBJECT_PARENT_ID, SNAPSHOT_ID, METRIC_NUM_VALUE, METRIC_OBJECT_ID, COMPUTE_VALUE)
  select T1.OBJECT_ID, I_METRIC_ID, I_METRIC_CHILD_ID, SC.MODULE_ID, I_SNAPSHOT_ID, 1, 0, 0
    from CTT_OBJECT_APPLICATIONS T1, DSSAPP_MODULES SC , ObjInf OI
        where SC.TECHNO_TYPE                                    = -4   -- Technologic Cobol object
          and T1.APPLICATION_ID                 = SC.MODULE_ID
      and T1.OBJECT_TYPE                                = 545 -- 'Cobol Program'
          and T1.PROPERTIES = 0 -- Application's Object
          and not exists ( select 1
                             from DSS_OBJECT_EXCEPTIONS E
                                    where E.METRIC_ID   = I_METRIC_ID
                                          and E.OBJECT_ID       = T1.OBJECT_ID
                              )
      and exists ( select 1
                          from ObjInf T2
                                     where T2.IdObj = T1.OBJECT_ID
                       and T2.InfTyp = 114 and T2.InfSubTyp = 1 -- Number of heading comment lines
                                           and T2.InfVal = 0
                           )
          and exists ( select 1
                          from ObjInf T3
                                     where T3.IdObj = T1.OBJECT_ID
                       and T3.InfTyp = 2 and T3.InfSubTyp = 0 -- Number of inner comment lines
                                           and T3.InfVal = 0
                           )

and T1.OBJECT_ID = OI.IdObj and OI.InfTyp    = 1 and OI.InfSubTyp = 0 and OI.InfVal > 0 -- has Code line


        ;
Return ERRORCODE;
End;
$body$
language 'plpgsql'
/

CREATE OR REPLACE FUNCTION DIAG_COBOL_ANA_PROGRAM_TOTAL (
        I_SNAPSHOT_ID          INT,             -- the metric snapshot id
        I_METRIC_PARENT_ID     INT,     -- the metric parent id
        I_METRIC_ID            INT,                     -- the metric id
        I_METRIC_VALUE_INDEX   INT
)
returns int
as
$body$
declare
        ERRORCODE       int;
Begin
    ERRORCODE  := 0;
--<<NAME>>DIAG_COBOL_ANA_PROGRAM_TOTAL<</NAME>>*/
--<<COMMENT>> Template name   = TOTAL. <</COMMENT>>
--<<COMMENT>> Definition      = Count of program programs. <</COMMENT>>

    Insert Into DSS_METRIC_RESULTS
                (METRIC_NUM_VALUE, METRIC_OBJECT_ID, OBJECT_ID, METRIC_ID, METRIC_VALUE_INDEX, SNAPSHOT_ID)
    select
                Count(T1.OBJECT_ID), 0, SC.OBJECT_PARENT_ID, I_METRIC_ID, I_METRIC_VALUE_INDEX, I_SNAPSHOT_ID
    from
        CTT_OBJECT_APPLICATIONS T1, DSSAPP_MODULES MO, DSS_METRIC_SCOPES SC
    where
            SC.SNAPSHOT_ID              = I_SNAPSHOT_ID
            and SC.METRIC_PARENT_ID     = I_METRIC_PARENT_ID
            and SC.METRIC_ID            = I_METRIC_ID
                and SC.COMPUTE_VALUE            = 0
                and MO.TECHNO_TYPE                      = -4   -- Technologic Cobol object
                and MO.MODULE_ID                        = SC.OBJECT_ID
                and T1.APPLICATION_ID           = SC.OBJECT_ID
                and T1.OBJECT_TYPE                      =     545 -- 'Cobol Program'
                and T1.PROPERTIES = 0 -- Application's Object

                and Not Exists
                (
                        select 1
                        from
                                DSS_OBJECT_EXCEPTIONS E
                        where
                                E.METRIC_ID             = I_METRIC_ID
                                and E.OBJECT_ID = T1.OBJECT_ID
                )
    Group By SC.OBJECT_PARENT_ID, SC.OBJECT_ID
        ;
Return ERRORCODE;
End;
$body$
language 'plpgsql'
/