Merge pull request #29 from sasjs/issue10

fix: adding checks for consul token access, and two tests to ensure t…

all.sas

@@ -1694,7 +1694,7 @@ Usage:
           input;
           i=1;
           stoploop=0;
-          if _n_ ge &logline-5 and stoploop=0 then do until (i>12);
+          if _n_ ge &logline-15 and stoploop=0 then do until (i>22);
             call symputx('logmsg',catx('\n',symget('logmsg'),_infile_));
             input;
             i+1;
@@ -2936,20 +2936,24 @@ run;
 %mend;/**
   @file
   @brief Drops tables / views (if they exist) without warnings in the log
-  @details
+  @details Useful for dropping tables when you're not sure they exist, or if
+  you are not sure whether they are a dataset or view.  Also efficient for
+  dropping multiple tables / views.
+
   Example usage:
 
       proc sql;
       create table data1 as select * from sashelp.class;
       create view view2 as select * from sashelp.class;
-      %mp_dropmembers(list=data1 view2)
+      %mp_dropmembers(data1 view2, libref=WORK)
+
 
   <h4> SAS Macros </h4>
   @li mf_isblank.sas
 
 
-  @param list space separated list of datasets / views
-  @param libref= can only drop from a single library at a time
+  @param list space separated list of datasets / views, WITHOUT libref
+  @param libref= (WORK) Note - you can only drop from a single library at a time
 
   @version 9.2
   @author Allan Bowe
@@ -2970,7 +2974,7 @@ run;
     delete &list;
     delete &list /mtype=view;
   run;
-%mend;/**
+%mend mp_dropmembers;/**
   @file
   @brief Create a CARDS file from a SAS dataset.
   @details Uses dataset attributes to convert all data into datalines.
@@ -3412,12 +3416,13 @@ run;
   @returns The &outds table containing any bad rows, plus a REASON_CD column.
 
   @param [in] inds The table to be checked, with the format above
-  @param [in] targetds= The target dataset against which to verify VARIABLE_NM
+  @param [in] targetds= The target dataset against which to verify VARIABLE_NM.
+    This must be available (ie, the library must be assigned).
   @param [out] abort= (YES) If YES will call mp_abort.sas on any exceptions
   @param [out] outds= The output table, which is a copy of the &inds. table
-  plus a REASON_CD column, containing only bad records.  If bad records found,
-  the SYSCC value will be set to 1008 (general data problem).  Downstream
-  processes should check this table (and return code) before continuing.
+    plus a REASON_CD column, containing only bad records.  If bad records found,
+    the SYSCC value will be set to 1008 (general data problem).  Downstream
+    processes should check this table (and return code) before continuing.
 
   <h4> SAS Macros </h4>
   @li mp_abort.sas
@@ -3463,41 +3468,52 @@ run;
   * quotes, commas, periods and spaces.
   * Only numeric values should remain
   */
-%local reason_cd;
+%local reason_cd nobs;
+%let nobs=0;
 data &outds;
   /*length GROUP_LOGIC SUBGROUP_LOGIC $3 SUBGROUP_ID 8 VARIABLE_NM $32
     OPERATOR_NM $10 RAW_VALUE $4000;*/
   set &inds;
-  length reason_cd $32;
+  length reason_cd $4032;
 
   /* closed list checks */
   if GROUP_LOGIC not in ('AND','OR') then do;
-    REASON_CD='GROUP_LOGIC should be either AND or OR';
+    REASON_CD='GROUP_LOGIC should be AND/OR, not:'!!cats(GROUP_LOGIC);
     putlog REASON_CD= GROUP_LOGIC=;
+    call symputx('reason_cd',reason_cd,'l');
+    call symputx('nobs',_n_,'l');
     output;
   end;
   if SUBGROUP_LOGIC not in ('AND','OR') then do;
-    REASON_CD='SUBGROUP_LOGIC should be either AND or OR';
+    REASON_CD='SUBGROUP_LOGIC should be AND/OR, not:'!!cats(SUBGROUP_LOGIC);
     putlog REASON_CD= SUBGROUP_LOGIC=;
+    call symputx('reason_cd',reason_cd,'l');
+    call symputx('nobs',_n_,'l');
     output;
   end;
   if mod(SUBGROUP_ID,1) ne 0 then do;
-    REASON_CD='SUBGROUP_ID should be integer';
+    REASON_CD='SUBGROUP_ID should be integer, not '!!left(subgroup_id);
     putlog REASON_CD= SUBGROUP_ID=;
+    call symputx('reason_cd',reason_cd,'l');
+    call symputx('nobs',_n_,'l');
     output;
   end;
   if upcase(VARIABLE_NM) not in
   (%upcase(%mf_getvarlist(&targetds,dlm=%str(,),quote=SINGLE)))
   then do;
-    REASON_CD="VARIABLE_NM not in &targetds";
+    REASON_CD="Variable "!!cats(variable_nm)!!" not in &targetds";
     putlog REASON_CD= VARIABLE_NM=;
+    call symputx('reason_cd',reason_cd,'l');
+    call symputx('nobs',_n_,'l');
     output;
   end;
   if OPERATOR_NM not in
   ('=','>','<','<=','>=','BETWEEN','IN','NOT IN','NE','CONTAINS')
   then do;
-    REASON_CD='Invalid OPERATOR_NM';
+    REASON_CD='Invalid OPERATOR_NM: '!!left(OPERATOR_NM);
     putlog REASON_CD= OPERATOR_NM=;
+    call symputx('reason_cd',reason_cd,'l');
+    call symputx('nobs',_n_,'l');
     output;
   end;
 
@@ -3507,8 +3523,10 @@ data &outds;
     if substr(raw_value,1,1) ne '('
     or substr(cats(reverse(raw_value)),1,1) ne ')'
     then do;
-      REASON_CD='Missing brackets in RAW_VALUE';
+      REASON_CD='Missing start/end bracket in RAW_VALUE';
       putlog REASON_CD= OPERATOR_NM= raw_value= raw_value1= ;
+      call symputx('reason_cd',reason_cd,'l');
+      call symputx('nobs',_n_,'l');
       output;
     end;
     else raw_value1=substr(raw_value,2,max(length(raw_value)-2,0));
@@ -3529,27 +3547,24 @@ data &outds;
   /* output records that contain values other than digits and spaces */
   if notdigit(compress(raw_value3,' '))>0 then do;
     putlog raw_value3= $hex32.;
-    REASON_CD='Invalid RAW_VALUE';
+    REASON_CD=cats('Invalid RAW_VALUE:',raw_value);
     putlog REASON_CD= raw_value= raw_value1= raw_value2= raw_value3=;
+    call symputx('reason_cd',reason_cd,'l');
+    call symputx('nobs',_n_,'l');
     output;
   end;
 
 run;
 
-%local nobs;
-%let nobs=0;
+
 data _null_;
   set &outds end=last;
   putlog (_all_)(=);
-  if last then do;
-    call symputx('REASON_CD',reason_cd,'l');
-    call symputx('nobs',_n_,'l');
-  end;
 run;
 
 %mp_abort(iftrue=(&abort=YES and &nobs>0),
   mac=&sysmacroname,
-  msg=%str(&nobs filter issues in &inds, reason: &reason_cd, details in &outds)
+  msg=%str(Data issue: %superq(reason_cd))
 )
 
 %if &nobs>0 %then %do;
@@ -3768,7 +3783,8 @@ filename &fref1 clear;
     run;
     %mp_abort(
       mac=&sysmacroname,
-      msg=%str(Filter issues in &inref: %quote(&reason_cd))
+      msg=%str(Filter validation issues. ERR=%superq(SYSERRORTEXT)
+        , WARN=%superq(SYSWARNINGTEXT) )
     )
   %end;
   %let syscc=1008;
@@ -5060,7 +5076,7 @@ create table &outds (rename=(
 )/*/STORE SOURCE*/;
 %put output location=&jref;
 %if &action=OPEN %then %do;
-  OPTIONS NOBOMFILE;
+  options nobomfile;
   data _null_;file &jref encoding='utf-8';
     put '{"START_DTTM" : "' "%sysfunc(datetime(),datetime20.3)" '"';
   run;
@@ -5713,7 +5729,15 @@ run;
 
       %mp_searchcols(libs=sashelp work, cols=name sex age)
 
-  @param libs=
+  @param libs=(SASHELP) Space separated list of libraries to search for columns
+  @param cols= Space separated list of column names to search for (not case
+    sensitive)
+  @param outds=(mp_searchcols) the table to create with the results.  Will have
+    one line per table match.
+  @param match=(ANY) The match type. Valid values:
+    @li ANY - The table contains at least one of the columns
+    @li WILD - The table contains a column with a name that partially matches
+
   @version 9.2
   @author Allan Bowe
 **/
@@ -5721,6 +5745,7 @@ run;
 %macro mp_searchcols(libs=sashelp
   ,cols=
   ,outds=mp_searchcols
+  ,match=ANY
 )/*/STORE SOURCE*/;
 
 %put &sysmacroname process began at %sysfunc(datetime(),datetime19.);
@@ -5742,8 +5767,10 @@ create table _data_ as
 %end;
   order by 1,2,3;
 
+%local tempds;
+%let tempds=&syslast;
 data &outds;
-  set &syslast;
+  set &tempds;
   length cols matchcols $32767;
   cols=upcase(symget('cols'));
   colcount=countw(cols);
@@ -5757,10 +5784,29 @@ data &outds;
     retain matchcols;
     matchcols='';
   end;
+%if &match=ANY %then %do;
   if findw(cols,name,,'spit') then do;
     sumcols+1;
     matchcols=cats(matchcols)!!' '!!cats(name);
   end;
+%end;
+%else %if &match=WILD %then %do;
+  if _n_=1 then do;
+    retain wcount;
+    wcount=countw(cols);
+    drop wcount;
+  end;
+  do i=1 to wcount;
+    length curword $32;
+    curword=scan(cols,i,' ');
+    drop curword;
+    if index(name,cats(curword)) then do;
+      sumcols+1;
+      matchcols=cats(matchcols)!!' '!!cats(curword);
+    end;
+  end;
+%end;
+
   if last.memname then do;
     if sumcols>0 then output;
     if sumcols=colcount then putlog "Full Match: " libname memname;
@@ -5770,10 +5816,11 @@ run;
 
 proc sort; by descending sumcols memname libname; run;
 
+proc sql;
+drop table &tempds;
 %put &sysmacroname process finished at %sysfunc(datetime(),datetime19.);
 
-%mend;
-/**
+%mend mp_searchcols;/**
   @file
   @brief Searches all data in a library
   @details
@@ -8890,7 +8937,7 @@ data _null_;
   put ')/*/STORE SOURCE*/; ';
   put '%put output location=&jref; ';
   put '%if &action=OPEN %then %do; ';
-  put '  OPTIONS NOBOMFILE; ';
+  put '  options nobomfile; ';
   put '  data _null_;file &jref encoding=''utf-8''; ';
   put '    put ''{"START_DTTM" : "'' "%sysfunc(datetime(),datetime20.3)" ''"''; ';
   put '  run; ';
@@ -13504,7 +13551,7 @@ data _null_;
   put ')/*/STORE SOURCE*/; ';
   put '%put output location=&jref; ';
   put '%if &action=OPEN %then %do; ';
-  put '  OPTIONS NOBOMFILE; ';
+  put '  options nobomfile; ';
   put '  data _null_;file &jref encoding=''utf-8''; ';
   put '    put ''{"START_DTTM" : "'' "%sysfunc(datetime(),datetime20.3)" ''"''; ';
   put '  run; ';
@@ -16334,8 +16381,8 @@ run;
       run;
 
 
-  @param [in] access_token_var= The global macro variable to contain the access
-    token
+  @param [in] access_token_var= The global macro variable to contain the
+              access token
   @param [in] grant_type= valid values:
       @li password
       @li authorization_code
@@ -16474,123 +16521,143 @@ data;run;%let jdswaitfor=&syslast;
 
 /* start loop */
 %do fid=1 %to &flowcnt;
-  %put preparing job attributes for flow &&flow&fid;
-  %local jds jcnt;
-  data &jds(drop=_contextName _program);
-    set &inds(where=(flow_id=&&flow&fid));
-    if _contextName='' then _contextName="SAS Job Execution compute context";
-    call symputx(cats('job',_n_),_program,'l');
-    call symputx(cats('context',_n_),_contextName,'l');
-    call symputx('jcnt',_n_,'l');
-  run;
-  %put exporting job variables in json format;
-  %do jid=1 %to &jcnt;
-    data &jjson;
-      set &jds;
-      if _n_=&jid then do;
-        output;
-        stop;
-      end;
-    run;
-    proc json out=&jfref;
-      export &jjson / nosastags fmtnumeric;
-    run;
-    data _null_;
-      infile &jfref lrecl=32767;
-      input;
-      jparams='jparams'!!left(symget('jid'));
-      call symputx(jparams,substr(_infile_,3,length(_infile_)-4));
-    run;
-    %local jobuid&jid;
-    %let jobuid&jid=0; /* used in next loop */
-  %end;
-  %local concurrency completed;
-  %let concurrency=0;
-  %let completed=0;
-  proc sql; drop table &jdsrunning;
-  %do jid=1 %to &jcnt;
-    /**
-      * now we can execute the jobs up to the maxconcurrency setting
-      */
-    %if "&&job&jid" ne "0" %then %do; /* this var is zero if job finished */
 
-      /* check to see if the job finished in the previous round */
-      %if %sysfunc(exist(&outds))=1 %then %do;
-        %local jobcheck;  %let jobcheck=0;
-        proc sql noprint;
-        select count(*) into: jobcheck
-          from &outds where uuid="&&jobuid&jid";
-        %if &jobcheck>0 %then %do;
-          %put &&job&jid in flow &fid with uid &&jobuid&jid completed!;
-          %let job&jid=0;
+  %if not ( &raise_err and &syscc ) %then %do;
+
+    %put preparing job attributes for flow &&flow&fid;
+    %local jds jcnt;
+    data &jds(drop=_contextName _program);
+      set &inds(where=(flow_id=&&flow&fid));
+      if _contextName='' then _contextName="SAS Job Execution compute context";
+      call symputx(cats('job',_n_),_program,'l');
+      call symputx(cats('context',_n_),_contextName,'l');
+      call symputx('jcnt',_n_,'l');
+    run;
+    %put exporting job variables in json format;
+    %do jid=1 %to &jcnt;
+      data &jjson;
+        set &jds;
+        if _n_=&jid then do;
+          output;
+          stop;
+        end;
+      run;
+      proc json out=&jfref;
+        export &jjson / nosastags fmtnumeric;
+      run;
+      data _null_;
+        infile &jfref lrecl=32767;
+        input;
+        jparams='jparams'!!left(symget('jid'));
+        call symputx(jparams,substr(_infile_,3,length(_infile_)-4));
+      run;
+      %local jobuid&jid;
+      %let jobuid&jid=0; /* used in next loop */
+    %end;
+    %local concurrency completed;
+    %let concurrency=0;
+    %let completed=0;
+    proc sql; drop table &jdsrunning;
+    %do jid=1 %to &jcnt;
+      /**
+        * now we can execute the jobs up to the maxconcurrency setting
+        */
+      %if "&&job&jid" ne "0" %then %do; /* this var is zero if job finished */
+
+        /* check to see if the job finished in the previous round */
+        %if %sysfunc(exist(&outds))=1 %then %do;
+          %local jobcheck;  %let jobcheck=0;
+          proc sql noprint;
+          select count(*) into: jobcheck
+            from &outds where uuid="&&jobuid&jid";
+          %if &jobcheck>0 %then %do;
+            %put &&job&jid in flow &fid with uid &&jobuid&jid completed!;
+            %let job&jid=0;
+          %end;
+        %end;
+
+        /* check if job was triggered and, if
+            so, if we have enough slots to run? */
+        %if ("&&jobuid&jid"="0") and (&concurrency<&maxconcurrency) %then %do;
+
+          /* But only start if no issues detected so far */
+          %if not ( &raise_err and &syscc ) %then %do;
+
+            %local jobname jobpath;
+            %let jobname=%scan(&&job&jid,-1,/);
+            %let jobpath=
+                  %substr(&&job&jid,1,%length(&&job&jid)-%length(&jobname)-1);
+
+            %put executing &jobpath/&jobname with paramstring &&jparams&jid;
+            %mv_jobexecute(path=&jobpath
+              ,name=&jobname
+              ,paramstring=%superq(jparams&jid)
+              ,outds=&jdsapp
+            )
+            data &jdsapp;
+              format jobparams $32767.;
+              set &jdsapp(where=(method='GET' and rel='state'));
+              jobparams=symget("jparams&jid");
+              /* uri here has the /state suffix */
+              uuid=scan(uri,-2,'/');
+              call symputx("jobuid&jid",uuid,'l');
+            run;
+            proc append base=&jdsrunning data=&jdsapp;
+            run;
+            %let concurrency=%eval(&concurrency+1);
+            /* sleep one second after every request to smooth the impact */
+            data _null_;
+              call sleep(1,1);
+            run;
+
+          %end;
+          %else %do; /* Job was skipped due to problems */
+
+            %put jobid &&job&jid in flow &fid skipped due to SYSCC (&syscc);
+            %let completed = %eval(&completed+1);
+            %let job&jid=0; /* Indicate job has finished */
+
+          %end;
+
         %end;
       %end;
+      %if &jid=&jcnt %then %do;
+        /* we are at the end of the loop - check which jobs have finished */
+        %mv_jobwaitfor(ANY,inds=&jdsrunning,outds=&jdswaitfor,outref=&outref
+                      ,raise_err=&raise_err,mdebug=&mdebug)
+        %local done;
+        %let done=%mf_nobs(&jdswaitfor);
+        %if &done>0 %then %do;
+          %let completed=%eval(&completed+&done);
+          %let concurrency=%eval(&concurrency-&done);
+          data &jdsapp;
+            set &jdswaitfor;
+            flow_id=&&flow&fid;
+            uuid=scan(uri,-1,'/');
+          run;
+          proc append base=&outds data=&jdsapp;
+          run;
+        %end;
+        proc sql;
+        delete from &jdsrunning
+          where uuid in (select uuid from &outds
+            where state in ('canceled','completed','failed')
+          );
 
-      /* check if job was triggered and if so, if we have enough slots to run */
-      %if "&&jobuid&jid"="0" and &concurrency<&maxconcurrency %then %do;
-        %local jobname jobpath;
-        %let jobname=%scan(&&job&jid,-1,/);
-        %let jobpath=
-          %substr(&&job&jid,1,%length(&&job&jid)-%length(&jobname)-1);
-        %put executing &jobpath/&jobname with paramstring &&jparams&jid;
-        %mv_jobexecute(path=&jobpath
-          ,name=&jobname
-          ,paramstring=%superq(jparams&jid)
-          ,outds=&jdsapp
-          ,mdebug=&mdebug
-        )
-        data &jdsapp;
-          format jobparams $32767.;
-          set &jdsapp(where=(method='GET' and rel='state'));
-          jobparams=symget("jparams&jid");
-          /* uri here has the /state suffix */
-          uuid=scan(uri,-2,'/');
-          call symputx("jobuid&jid",uuid,'l');
-        run;
-        proc append base=&jdsrunning data=&jdsapp;
-        run;
-        %let concurrency=%eval(&concurrency+1);
-        /* sleep one second after every request to smooth the impact */
-        data _null_;
-          call sleep(1,1);
-        run;
+        /* loop again if jobs are left */
+        %if &completed < &jcnt %then %do;
+          %let jid=0;
+          %put looping flow &fid again;
+          %put &completed of &jcnt jobs completed, &concurrency jobs running;
+        %end;
       %end;
     %end;
-    %if &jid=&jcnt %then %do;
-      /* we are at the end of the loop - time to see which jobs have finished */
-      %mv_jobwaitfor(ANY
-        ,inds=&jdsrunning
-        ,outds=&jdswaitfor
-        ,outref=&outref
-        ,raise_err=&raise_err
-        ,mdebug=&mdebug
-      )
-      %local done;
-      %let done=%mf_nobs(&jdswaitfor);
-      %if &done>0 %then %do;
-        %let completed=%eval(&completed+&done);
-        %let concurrency=%eval(&concurrency-&done);
-        data &jdsapp;
-          set &jdswaitfor;
-          flow_id=&&flow&fid;
-          uuid=scan(uri,-1,'/');
-        run;
-        proc append base=&outds data=&jdsapp;
-        run;
-      %end;
-      proc sql;
-      delete from &jdsrunning
-        where uuid in (select uuid from &outds
-          where state in ('canceled','completed','failed')
-        );
 
-      /* loop again if jobs are left */
-      %if &completed < &jcnt %then %do;
-        %let jid=0;
-        %put looping flow &fid again - &completed of &jcnt jobs completed,
-          &concurrency jobs running;
-      %end;
-    %end;
+  %end;
+  %else %do;
+
+    %put Flow &&flow&fid skipped due to SYSCC (&syscc);
+
   %end;
   /* back up and execute the next flow */
 %end;
@@ -16865,14 +16932,22 @@ run;
 %mend mv_jobwaitfor;/**
   @file mv_registerclient.sas
   @brief Register Client and Secret (admin task)
-  @details When building apps on SAS Viya, an client id and secret is required.
-  This macro will obtain the Consul Token and use that to call the Web Service.
+  @details When building apps on SAS Viya, an client id and secret are sometimes
+  required.  In order to generate them, filesystem access to the Consul Token
+  is needed (it is not enough to be in the SASAdministrator group in SAS
+  Environment Manager).
 
-  more info: https://developer.sas.com/reference/auth/#register
-  and:
-  http://proc-x.com/2019/01/authentication-to-sas-viya-a-couple-of-approaches
+  If you are registering a lot of clients / secrets, you may find it more
+  convenient to use the [Viya Token Generator]
+  (https://sasjs.io/apps/#viya-client-token-generator) (a SASjs Web App to
+  automate the generation of clients & secrets with various settings).
 
-  The default viyaroot location is /opt/sas/viya/config
+  For further information on clients / secrets, see;
+  @li https://developer.sas.com/reference/auth/#register
+  @li https://proc-x.com/2019/01/authentication-to-sas-viya-a-couple-of-approaches
+  @li https://cli.sasjs.io/faq/#how-can-i-obtain-a-viya-client-and-secret
+
+  The default viyaroot location is: `/opt/sas/viya/config`
 
   Usage:
 
@@ -16897,16 +16972,19 @@ run;
       )
 
   @param client_id= The client name.  Auto generated if blank.
-  @param client_secret= Client secret  Auto generated if client is blank.
-  @param scopes= list of space-seperated unquoted scopes (default is openid)
-  @param grant_type= valid values are "password" or "authorization_code"
-    (unquoted)
-  @param outds= the dataset to contain the registered client id and secret
-  @param access_token_validity= The duration of validity of the access token
-    in seconds.  A value of DEFAULT will omit the entry (and use system default)
-  @param refresh_token_validity= The duration of validity of the refresh token
-    in seconds.  A value of DEFAULT will omit the entry (and use system default)
-  @param name= A human readable name for the client
+  @param client_secret= Client secret.  Auto generated if client is blank.
+  @param scopes=(openid) List of space-seperated unquoted scopes
+  @param grant_type=(authorization_code|refresh_token) Valid values are
+    "password" or "authorization_code" (unquoted)
+  @param outds=(mv_registerclient) The dataset to contain the registered client
+    id and secret
+  @param access_token_validity=(DEFAULT) The duration of validity of the access
+    token in seconds.  A value of DEFAULT will omit the entry (and use system
+    default)
+  @param refresh_token_validity=(DEFAULT)  The duration of validity of the
+    refresh token in seconds.  A value of DEFAULT will omit the entry (and use
+    system default)
+  @param name= An optional, human readable name for the client
   @param required_user_groups= A list of group names. If a user does not belong
     to all the required groups, the user will not be authenticated and no tokens
     are issued to this client for that user. If this field is not specified,
@@ -16915,8 +16993,8 @@ run;
     apply.  Setting this to true will autoapprove all the client scopes.
   @param use_session= If true, access tokens issued to this client will be
     associated with an HTTP session and revoked upon logout or time-out.
-  @param outjson= A dataset containing the lines of JSON submitted.  Useful
-    for debugging.  Default= _null_.
+  @param outjson= (_null_) A dataset containing the lines of JSON submitted.
+    Useful for debugging.
 
   @version VIYA V.03.04
   @author Allan Bowe, source: https://github.com/sasjs/core
@@ -16953,12 +17031,26 @@ run;
 options noquotelenmax;
 /* first, get consul token needed to get client id / secret */
 %let tokloc=/etc/SASSecurityCertificateFramework/tokens/consul/default;
+%let tokloc=%mf_loc(VIYACONFIG)&tokloc/client.token;
+
+
+%mp_abort(iftrue=(%sysfunc(fileexist(&tokloc))=0)
+  ,mac=&sysmacroname
+  ,msg=%str(Unable to access the consul token at &tokloc)
+)
+
+%let consul_token=0;
 data _null_;
-  infile "%mf_loc(VIYACONFIG)&tokloc/client.token";
+  infile "&tokloc";
   input token:$64.;
   call symputx('consul_token',token);
 run;
 
+%mp_abort(iftrue=("&consul_token"="0")
+  ,mac=&sysmacroname
+  ,msg=%str(Unable to source the consul token from &tokloc)
+)
+
 %local base_uri; /* location of rest apis */
 %let base_uri=%mf_getplatform(VIYARESTAPI);
 
@@ -17105,7 +17197,7 @@ filename &fname2 clear;
 filename &fname3 clear;
 libname &libref clear;
 
-%mend;
+%mend mv_registerclient;
 /**
   @file mv_tokenauth.sas
   @brief Get initial Refresh and Access Tokens
@@ -17626,6 +17718,8 @@ filename &fref1 clear;
 %macro ml_json();
 data _null_;
   file "%sysfunc(pathname(work))/ml_json.lua";
+  put '-- NOTE - THE COPYRIGHT BELOW IS IN RELATION TO THE JSON.LUA FILE ONLY ';
+  put '-- THIS FILE STARTS ON THE NEXT LINE AND WILL FINISH WITH "JSON.LUA ENDS HERE" ';
   put '-- ';
   put '-- json.lua ';
   put '-- ';
@@ -17997,6 +18091,8 @@ data _null_;
   put 'end ';
   put ' ';
   put 'return json ';
+  put ' ';
+  put '-- JSON.LUA ENDS HERE ';
 run;
 
 %inc "%sysfunc(pathname(work))/ml_json.lua";

base/mp_dropmembers.sas

@@ -1,20 +1,24 @@
 /**
   @file
   @brief Drops tables / views (if they exist) without warnings in the log
-  @details
+  @details Useful for dropping tables when you're not sure they exist, or if
+  you are not sure whether they are a dataset or view.  Also efficient for
+  dropping multiple tables / views.
+
   Example usage:
 
       proc sql;
       create table data1 as select * from sashelp.class;
       create view view2 as select * from sashelp.class;
-      %mp_dropmembers(list=data1 view2)
+      %mp_dropmembers(data1 view2, libref=WORK)
+
 
   <h4> SAS Macros </h4>
   @li mf_isblank.sas
 
 
-  @param list space separated list of datasets / views
-  @param libref= can only drop from a single library at a time
+  @param list space separated list of datasets / views, WITHOUT libref
+  @param libref= (WORK) Note - you can only drop from a single library at a time
 
   @version 9.2
   @author Allan Bowe
@@ -35,4 +39,4 @@
     delete &list;
     delete &list /mtype=view;
   run;
-%mend;
+%mend mp_dropmembers;

base/mp_searchcols.sas

@@ -9,7 +9,15 @@
 
       %mp_searchcols(libs=sashelp work, cols=name sex age)
 
-  @param libs=
+  @param libs=(SASHELP) Space separated list of libraries to search for columns
+  @param cols= Space separated list of column names to search for (not case
+    sensitive)
+  @param outds=(mp_searchcols) the table to create with the results.  Will have
+    one line per table match.
+  @param match=(ANY) The match type. Valid values:
+    @li ANY - The table contains at least one of the columns
+    @li WILD - The table contains a column with a name that partially matches
+
   @version 9.2
   @author Allan Bowe
 **/
@@ -17,6 +25,7 @@
 %macro mp_searchcols(libs=sashelp
   ,cols=
   ,outds=mp_searchcols
+  ,match=ANY
 )/*/STORE SOURCE*/;
 
 %put &sysmacroname process began at %sysfunc(datetime(),datetime19.);
@@ -38,8 +47,10 @@ create table _data_ as
 %end;
   order by 1,2,3;
 
+%local tempds;
+%let tempds=&syslast;
 data &outds;
-  set &syslast;
+  set &tempds;
   length cols matchcols $32767;
   cols=upcase(symget('cols'));
   colcount=countw(cols);
@@ -53,10 +64,29 @@ data &outds;
     retain matchcols;
     matchcols='';
   end;
+%if &match=ANY %then %do;
   if findw(cols,name,,'spit') then do;
     sumcols+1;
     matchcols=cats(matchcols)!!' '!!cats(name);
   end;
+%end;
+%else %if &match=WILD %then %do;
+  if _n_=1 then do;
+    retain wcount;
+    wcount=countw(cols);
+    drop wcount;
+  end;
+  do i=1 to wcount;
+    length curword $32;
+    curword=scan(cols,i,' ');
+    drop curword;
+    if index(name,cats(curword)) then do;
+      sumcols+1;
+      matchcols=cats(matchcols)!!' '!!cats(curword);
+    end;
+  end;
+%end;
+
   if last.memname then do;
     if sumcols>0 then output;
     if sumcols=colcount then putlog "Full Match: " libname memname;
@@ -66,6 +96,8 @@ run;
 
 proc sort; by descending sumcols memname libname; run;
 
+proc sql;
+drop table &tempds;
 %put &sysmacroname process finished at %sysfunc(datetime(),datetime19.);
 
-%mend;
+%mend mp_searchcols;

lua/json.lua

@@ -1,3 +1,5 @@
+-- NOTE - THE COPYRIGHT BELOW IS IN RELATION TO THE JSON.LUA FILE ONLY
+-- THIS FILE STARTS ON THE NEXT LINE AND WILL FINISH WITH "JSON.LUA ENDS HERE"
 --
 -- json.lua
 --
@@ -369,3 +371,5 @@ function json.decode(str)
 end
 
 return json
+
+-- JSON.LUA ENDS HERE

lua/ml_json.sas

@@ -12,6 +12,8 @@
 %macro ml_json();
 data _null_;
   file "%sysfunc(pathname(work))/ml_json.lua";
+  put '-- NOTE - THE COPYRIGHT BELOW IS IN RELATION TO THE JSON.LUA FILE ONLY ';
+  put '-- THIS FILE STARTS ON THE NEXT LINE AND WILL FINISH WITH "JSON.LUA ENDS HERE" ';
   put '-- ';
   put '-- json.lua ';
   put '-- ';
@@ -383,6 +385,8 @@ data _null_;
   put 'end ';
   put ' ';
   put 'return json ';
+  put ' ';
+  put '-- JSON.LUA ENDS HERE ';
 run;
 
 %inc "%sysfunc(pathname(work))/ml_json.lua";

meta/mm_createwebservice.sas

@@ -90,7 +90,7 @@ data _null_;
   put ')/*/STORE SOURCE*/; ';
   put '%put output location=&jref; ';
   put '%if &action=OPEN %then %do; ';
-  put '  OPTIONS NOBOMFILE; ';
+  put '  options nobomfile; ';
   put '  data _null_;file &jref encoding=''utf-8''; ';
   put '    put ''{"START_DTTM" : "'' "%sysfunc(datetime(),datetime20.3)" ''"''; ';
   put '  run; ';

tests/base/mp_searchcols.test.sas

@@ -0,0 +1,50 @@
+/**
+  @file
+  @brief Testing mp_searchcols.sas
+
+  <h4> SAS Macros </h4>
+  @li mp_searchcols.sas
+  @li mp_assertdsobs.sas
+
+
+**/
+
+
+/** Test 1 - full col match  */
+data example1;
+  var1=1;
+  var2=2;
+  var3=3;
+data example2;
+  var1=1;
+  var2=2;
+data example3;
+  var2=2;
+  var3=3;
+data example4;
+  matchmehere=1;
+data example5;
+  hereyoucan_matchme_also=1;
+data example6;
+  do_not_forget_me=1;
+data example7;
+  we_shall_not_forget=1;
+run;
+
+%mp_searchcols(libs=work,cols=var1 var2,outds=testme)
+
+%mp_assertdsobs(work.testme,
+  desc=Test1 - check exact variables are found,
+  test=EQUALS 3,
+  outds=work.test_results
+)
+
+/* test 2 - wildcard match */
+
+%mp_searchcols(libs=work,cols=matchme forget,match=WILD, outds=testme2)
+
+%mp_assertdsobs(work.testme2,
+  desc=Test1 - check fuzzy matches are found,
+  test=EQUALS 4,
+  outds=work.test_results
+)

tests/viya/mv_registerclient.test.1.sas

@@ -0,0 +1,36 @@
+/**
+
+  @file
+  @brief Testing mv_registerclient.sas macro
+  @details Tests for successful registration.  For this to work, the test
+  account must be an admin.
+​
+  <h4> SAS Macros </h4>
+  @li mf_getuniquename.sas
+  @li mp_assertcolvals.sas
+  @li mv_registerclient.sas
+
+**/
+
+/**
+  * Test Case 1
+  */
+
+%let id=%mf_getuniquename();
+%let sec=%mf_getuniquename();
+%mv_registerclient(client_id=&id,client_secret=&sec, outds=testds)
+
+data work.checkds;
+  id="&id";
+  sec="&sec";
+run;
+%mp_assertcolvals(work.testds.client_id,
+  checkvals=work.checkds.id,
+  desc=Checking client id was created
+  test=ALLVALS
+)
+%mp_assertcolvals(work.testds.client_secret,
+  checkvals=work.checkds.sec,
+  desc=Checking client secret was created
+  test=ALLVALS
+)

tests/viya/mv_registerclient.test.2.sas

@@ -0,0 +1,43 @@
+/**
+
+  @file
+  @brief Testing mv_registerclient.sas macro
+  @details Tests for unsuccessful registration.  To do this, overrides are
+  applied for the mf_loc.sas and mp_abort.sas macros.
+​
+  <h4> SAS Macros </h4>
+  @li mp_assert.sas
+  @li mv_registerclient.sas
+
+**/
+
+/**
+  * Test Case
+  */
+
+%macro mf_loc(param);
+  /does/not/exist
+%mend mf_loc;
+
+%macro mp_abort(iftrue=,mac=mp_abort.sas, type=, msg=);
+  %if not(%eval(%unquote(&iftrue))) %then %return;
+  %put %substr(&msg,1,16);
+  %mp_assert(
+    iftrue=("%substr(&msg,1,16)"="Unable to access"),
+    desc=Check that abort happens when consul token is unavailable
+  )
+  %webout(OPEN)
+  %webout(OBJ, TEST_RESULTS)
+  %webout(CLOSE)
+  %let syscc=0;
+  data _null_;
+    abort cancel nolist;
+  run;
+%mend mp_abort;
+
+%mv_registerclient( outds=testds)
+
+%mp_assert(
+  iftrue=(0=1),
+  desc=Check that abort happens when consul token is unavailable
+)

viya/mv_createwebservice.sas

@@ -241,7 +241,7 @@ data _null_;
   put ')/*/STORE SOURCE*/; ';
   put '%put output location=&jref; ';
   put '%if &action=OPEN %then %do; ';
-  put '  OPTIONS NOBOMFILE; ';
+  put '  options nobomfile; ';
   put '  data _null_;file &jref encoding=''utf-8''; ';
   put '    put ''{"START_DTTM" : "'' "%sysfunc(datetime(),datetime20.3)" ''"''; ';
   put '  run; ';

viya/mv_registerclient.sas

@@ -1,14 +1,22 @@
 /**
   @file mv_registerclient.sas
   @brief Register Client and Secret (admin task)
-  @details When building apps on SAS Viya, an client id and secret is required.
-  This macro will obtain the Consul Token and use that to call the Web Service.
+  @details When building apps on SAS Viya, an client id and secret are sometimes
+  required.  In order to generate them, filesystem access to the Consul Token
+  is needed (it is not enough to be in the SASAdministrator group in SAS
+  Environment Manager).
 
-  more info: https://developer.sas.com/reference/auth/#register
-  and:
-  http://proc-x.com/2019/01/authentication-to-sas-viya-a-couple-of-approaches
+  If you are registering a lot of clients / secrets, you may find it more
+  convenient to use the [Viya Token Generator]
+  (https://sasjs.io/apps/#viya-client-token-generator) (a SASjs Web App to
+  automate the generation of clients & secrets with various settings).
 
-  The default viyaroot location is /opt/sas/viya/config
+  For further information on clients / secrets, see;
+  @li https://developer.sas.com/reference/auth/#register
+  @li https://proc-x.com/2019/01/authentication-to-sas-viya-a-couple-of-approaches
+  @li https://cli.sasjs.io/faq/#how-can-i-obtain-a-viya-client-and-secret
+
+  The default viyaroot location is: `/opt/sas/viya/config`
 
   Usage:
 
@@ -33,16 +41,19 @@
       )
 
   @param client_id= The client name.  Auto generated if blank.
-  @param client_secret= Client secret  Auto generated if client is blank.
-  @param scopes= list of space-seperated unquoted scopes (default is openid)
-  @param grant_type= valid values are "password" or "authorization_code"
-    (unquoted)
-  @param outds= the dataset to contain the registered client id and secret
-  @param access_token_validity= The duration of validity of the access token
-    in seconds.  A value of DEFAULT will omit the entry (and use system default)
-  @param refresh_token_validity= The duration of validity of the refresh token
-    in seconds.  A value of DEFAULT will omit the entry (and use system default)
-  @param name= A human readable name for the client
+  @param client_secret= Client secret.  Auto generated if client is blank.
+  @param scopes=(openid) List of space-seperated unquoted scopes
+  @param grant_type=(authorization_code|refresh_token) Valid values are
+    "password" or "authorization_code" (unquoted)
+  @param outds=(mv_registerclient) The dataset to contain the registered client
+    id and secret
+  @param access_token_validity=(DEFAULT) The duration of validity of the access
+    token in seconds.  A value of DEFAULT will omit the entry (and use system
+    default)
+  @param refresh_token_validity=(DEFAULT)  The duration of validity of the
+    refresh token in seconds.  A value of DEFAULT will omit the entry (and use
+    system default)
+  @param name= An optional, human readable name for the client
   @param required_user_groups= A list of group names. If a user does not belong
     to all the required groups, the user will not be authenticated and no tokens
     are issued to this client for that user. If this field is not specified,
@@ -51,8 +62,8 @@
     apply.  Setting this to true will autoapprove all the client scopes.
   @param use_session= If true, access tokens issued to this client will be
     associated with an HTTP session and revoked upon logout or time-out.
-  @param outjson= A dataset containing the lines of JSON submitted.  Useful
-    for debugging.  Default= _null_.
+  @param outjson= (_null_) A dataset containing the lines of JSON submitted.
+    Useful for debugging.
 
   @version VIYA V.03.04
   @author Allan Bowe, source: https://github.com/sasjs/core
@@ -89,12 +100,26 @@
 options noquotelenmax;
 /* first, get consul token needed to get client id / secret */
 %let tokloc=/etc/SASSecurityCertificateFramework/tokens/consul/default;
+%let tokloc=%mf_loc(VIYACONFIG)&tokloc/client.token;
+
+
+%mp_abort(iftrue=(%sysfunc(fileexist(&tokloc))=0)
+  ,mac=&sysmacroname
+  ,msg=%str(Unable to access the consul token at &tokloc)
+)
+
+%let consul_token=0;
 data _null_;
-  infile "%mf_loc(VIYACONFIG)&tokloc/client.token";
+  infile "&tokloc";
   input token:$64.;
   call symputx('consul_token',token);
 run;
 
+%mp_abort(iftrue=("&consul_token"="0")
+  ,mac=&sysmacroname
+  ,msg=%str(Unable to source the consul token from &tokloc)
+)
+
 %local base_uri; /* location of rest apis */
 %let base_uri=%mf_getplatform(VIYARESTAPI);
 
@@ -241,4 +266,4 @@ filename &fname2 clear;
 filename &fname3 clear;
 libname &libref clear;
 
-%mend;
+%mend mv_registerclient;