sasjs/core
1
0
Fork 0
mirror of https://github.com/sasjs/core.git synced 2026-01-16 13:00:05 +00:00
Code Issues Projects Releases Wiki Activity

fix: apply viya file type properties to newly created viya files

Browse Source
This commit is contained in:
Trevor Moody
2025-11-12 11:17:31 +00:00
parent 14aeb585ae
commit 569533b218
3 changed files with 343 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
tests/viyaonly/mv_getviyafileextparms.test.sas Normal file
View File

@@ -0,0 +1,95 @@
/**
@file
@brief Testing mv_getviyafileextparms macro
<h4> SAS Macros </h4>
@li mf_isBlank.sas
@li mp_assert.sas
@li mp_assertscope.sas
@li mv_getviyafileextparms.sas
**/
options mprint;
%let mvarIgnoreList =
MC0_JADP1LEN MC0_JADP2LEN MC0_JADP3LEN MC0_JADPNUM MC0_JADVLEN;
%put TEST 1 - Test with common extension, requesting only typeDefName parameter;
%mp_assertscope(SNAPSHOT)
%mv_getviyafileextparms(ext=txt, typeDefNameVar=viyaTypeDefName)
%mp_assertscope(COMPARE
,ignorelist=&mvarIgnoreList viyaTypeDefName
)
%mp_assert(
iftrue=(not %mf_isBlank(&viyaTypeDefName)),
desc=Check the requested macro variable viyaTypeDefName is not blank.
)
%put TEST 2 - Test with common extension, requesting only properties parameter;
%mp_assertscope(SNAPSHOT)
%mv_getviyafileextparms(ext=html, propertiesVar=viyaProperties)
%mp_assertscope(COMPARE
,ignorelist=&mvarIgnoreList viyaProperties
)
%mp_assert(
iftrue=(not %mf_isBlank(&viyaProperties)),
desc=Check the requested macro variable viyaProperties is not blank.
)
%put TEST 3 - Test with common extension, requesting only mediaType parameter;
%mp_assertscope(SNAPSHOT)
%mv_getviyafileextparms(ext=mp3, mediaTypeVar=viyaMediaType)
%mp_assertscope(COMPARE
,ignorelist=&mvarIgnoreList viyaMediaType
)
%mp_assert(
iftrue=(not %mf_isBlank(&viyaMediaType)),
desc=Check the requested macro variable viyaMediaType is not blank.
)
%put TEST 4 - Test with common extension, requesting all parameters;
%mp_assertscope(SNAPSHOT)
%mv_getviyafileextparms(
ext=css,
typeDefNameVar=cssViyaTypeDefName,
propertiesVar=cssViyaProperties,
mediaTypeVar=cssViyaMediaType
)
%mp_assertscope(COMPARE
,ignorelist=
&mvarIgnoreList cssViyaTypeDefName cssViyaProperties cssViyaMediaType
)
%mp_assert(
iftrue=(not ( %mf_isBlank(&cssViyaTypeDefName) or
%mf_isBlank(&cssViyaProperties) or
%mf_isBlank(&cssViyaMediaType) ) ),
desc=Check a full set of requested macro variables are not blank.
)
%put TEST 5 - Test with invalid extension - requested parameters will be blank;
%mp_assertscope(SNAPSHOT)
%mv_getviyafileextparms(
ext=xxxINVALIDxxx,
typeDefNameVar=invalidTypeDefName,
propertiesVar=invalidProperties,
mediaTypeVar=invalidMediaType
)
%mp_assertscope(COMPARE
,ignorelist=
&mvarIgnoreList invalidTypeDefName invalidProperties invalidMediaType
)
%mp_assert(
iftrue=(
%mf_isBlank(&invalidTypeDefName) and
%mf_isBlank(&invalidProperties) and
%mf_isBlank(&invalidMediaType)
),
desc=Check the requested macro variables are all blank.
)

88
viya/mv_createfile.sas
View File

@@ -69,6 +69,7 @@
@li mp_base64copy.sas @li mp_base64copy.sas
@li mp_replace.sas @li mp_replace.sas
@li mv_createfolder.sas @li mv_createfolder.sas
@li mv_getviyafileextparms.sas
<h4> Related Macros</h4> <h4> Related Macros</h4>
@li mv_createfile.sas @li mv_createfile.sas
@@ -153,7 +154,7 @@
options noquotelenmax; options noquotelenmax;
%local base_uri; /* location of rest apis */ %local base_uri; /* location of rest apis */
%let base_uri=%mf_getplatform(VIYARESTAPI); %let base_uri=%trim(%mf_getplatform(VIYARESTAPI));
/* create folder if it does not already exist */ /* create folder if it does not already exist */
%local folderds self_uri; %local folderds self_uri;
@@ -172,7 +173,7 @@ run;
/* abort or delete if file already exists */ /* abort or delete if file already exists */
%let force=%upcase(&force); %let force=%upcase(&force);
%local fileuri ; %local fileuri ;
%let fileuri=%mfv_getpathuri(&path/&name); %let fileuri=%trim(%mfv_getpathuri(&path/&name));
%mp_abort(iftrue=(%mf_isblank(&fileuri)=0 and &force ne YES) %mp_abort(iftrue=(%mf_isblank(&fileuri)=0 and &force ne YES)
,mac=MV_CREATEFILE ,mac=MV_CREATEFILE
,msg=%str(File &path/&name already exists and force=&force) ,msg=%str(File &path/&name already exists and force=&force)
@@ -201,6 +202,12 @@ run;
%let url=&base_uri/files/files?parentFolderUri=&self_uri; %let url=&base_uri/files/files?parentFolderUri=&self_uri;
%let ext=%upcase(%scan(&name,-1,.)); %let ext=%upcase(%scan(&name,-1,.));
/* Get Viya file-extension details into some macro variables */
%mv_getViyaFileExtParms(&ext
,propertiesVar=viyaProperties
,typeDefNameVar=viyaTypeDefName
,mdebug=&mdebug);
/* fetch job info */ /* fetch job info */
%local fname1; %local fname1;
%let fname1=%mf_getuniquefileref(); %let fname1=%mf_getuniquefileref();
@@ -212,12 +219,18 @@ proc http method='POST' out=&fname1 &oauth_bearer in=&fref
%else %do; %else %do;
ct="&ctype" ct="&ctype"
%end; %end;
%if "&ext"="HTML" or "&ext"="CSS" or "&ext"="JS" or "&ext"="PNG"
or "&ext"="SVG" %then %do; %if not %mf_isBlank(&viyaTypeDefName) %then %do;
url="&url%str(&)typeDefName=file"; url="&url%str(&)typeDefName=&viyaTypeDefName";
%end; %end;
%else %do; %else %do;
url="&url"; %if "&ext"="HTML" or "&ext"="CSS" or "&ext"="JS" or "&ext"="PNG"
or "&ext"="SVG" %then %do;
url="&url%str(&)typeDefName=file";
%end;
%else %do;
url="&url";
%end;
%end; %end;
headers "Accept"="application/json" headers "Accept"="application/json"
@@ -239,26 +252,63 @@ run;
,mac=MV_CREATEFILE ,mac=MV_CREATEFILE
,msg=%str(&SYS_PROCHTTP_STATUS_CODE &SYS_PROCHTTP_STATUS_PHRASE) ,msg=%str(&SYS_PROCHTTP_STATUS_CODE &SYS_PROCHTTP_STATUS_PHRASE)
) )
%local libref2;
%let libref2=%mf_getuniquelibref();
libname &libref2 JSON fileref=&fname1;
/* Grab the follow on link */
data &outds;
set &libref2..links end=last;
if rel='createChild' then do;
call symputx('href',quote(cats("&base_uri",href)),'l');
&dbg put (_all_)(=);
end;
run;
%put &sysmacroname: %trim(&base_uri)%mfv_getpathuri(&path/&name); /* URI of the created file */
%let fileuri=%trim(%mfv_getpathuri(&path/&name));
/* If properties were found then patch the file to include them */
%if not %mf_isBlank(&viyaProperties) %then %do;
/* Wrap the properties object in a root object also containing the file name */
%local viyapatch;
%let viyapatch = %sysfunc(pathname(work))/%mf_getuniquename(prefix=patch_json_);
data _null_;
length line $32767;
file "&viyapatch" lrecl=32767;
put '{ "name": "' "&name" '",';
line = cat('"properties": ',symget("viyaProperties"));
put line;
put '}';
stop;
run;
%if &mdebug=1 %then %do;
data _null_;
if (_n_ eq 1) then put 'DEBUG: ** PATCH JSON **';
infile "&viyapatch" end=last;
input;
put _infile_;
run;
%end;
/* And apply the properties to the newly created file, using the PATCH method */
%let fref=%mf_getuniquefileref();
filename &fref "&viyapatch";
%let url=&base_uri&fileuri;
proc http method='PATCH' oauth_bearer=sas_services in=&fref
url="&url";
headers "Accept"="application/json"
"Content-Type"="application/json"
"If-Match"="*";
%if &mdebug=1 %then %do;
debug level=2;
%end;
run;
%if &mdebug=1 %then %put &sysmacroname PATCH &=url
&=SYS_PROCHTTP_STATUS_CODE &=SYS_PROCHTTP_STATUS_PHRASE;
%mp_abort(iftrue=(&SYS_PROCHTTP_STATUS_CODE ne 200)
,mac=MV_CREATEFILE
,msg=%str(&SYS_PROCHTTP_STATUS_CODE &SYS_PROCHTTP_STATUS_PHRASE)
)
%end;
%put &sysmacroname: &base_uri&fileuri;
%put /SASJobExecution?_file=&path/&name;%put; %put /SASJobExecution?_file=&path/&name;%put;
%if &mdebug=0 %then %do; %if &mdebug=0 %then %do;
/* clear refs */ /* clear refs */
filename &fname1 clear; filename &fname1 clear;
filename &fref clear; filename &fref clear;
libname &libref2 clear;
%end; %end;
%mp_abort( %mp_abort(

179
viya/mv_getviyafileextparms.sas Normal file
View File

@@ -0,0 +1,179 @@
/**
@file mv_getviyafileextparms.sas
@brief Reads the VIYA file-extension type definition and returns selected
values in SAS macro variables
@details Content is derived from the following endpoint:
"https://<srv>/types/types?filter=contains(extensions,'<some ext>')"
@param [in] ext File extension to retrieve property info for.
@param [out] propertiesVar= SAS macro variable name that will contain
the 'properties' object json, if found, else blank.
@param [out] typeDefNameVar= SAS macro variable name that will contain
the 'typeDefName' property value, if found, else blank.
@param [out] mediaTypeVar= SAS macro variable name that will contain
the 'mediaType' property value, if found, else blank.
@param [in] mdebug= (0) Set to 1 to enable DEBUG messages
<h4> SAS Macros </h4>
@li mf_abort.sas
@li mf_existds.sas
@li mf_getplatform.sas
@li mf_getuniquefileref.sas
@li mf_getuniquename.sas
@li mf_getvalue.sas
@li mf_getvarlist.sas
@li mf_getvartype.sas
*/
%macro mv_getViyaFileExtParms(ext,typeDefNameVar=,propertiesVar=,mediaTypeVar=,mdebug=0);
%local base_uri; /* location of rest apis */
%local viyatypedef; /* temp fileref to json response */
%local url; /* File extension info end-point */
%mf_abort(iftrue=(%mf_isBlank(&ext))
,msg=%str(MV_GETVIYAFILEEXTPARMS - No file extension provided.)
);
%mf_abort(iftrue=(%mf_isBlank(&typeDefNameVar) and
%mf_isBlank(&propertiesVar) and
%mf_isBlank(&mediaTypeVar))
,msg=%str(MV_GETVIYAFILEEXTPARMS - No parameter was requested.)
);
/* Declare requested parameters as global macro vars and initialize blank */
%if not %mf_isBlank(&typeDefNameVar) %then %do;
%global &typeDefNameVar;
%let &typeDefNameVar = %str();
%end;
%if not %mf_isBlank(&propertiesVar) %then %do;
%global &propertiesVar;
%let &propertiesVar = %str();
%end;
%if not %mf_isBlank(&mediaTypeVar) %then %do;
%global &mediaTypeVar;
%let &mediaTypeVar = %str();
%end;
%let base_uri=%mf_getplatform(VIYARESTAPI);
%if &mdebug=1 %then %do;
%put DEBUG: &SYSMACRONAME &=base_uri;
%end;
%let ext=%lowcase(&ext);
/* Create a temp file and fill with JSON that declares */
/* VIYA file-type details for the given file extension */
%let viyatypedef=%mf_getuniquefileref();
filename &viyatypedef temp;
%let url = &base_uri/types/types?filter=contains(extensions,%str(%')&ext%str(%'));
proc http oauth_bearer=sas_services out=&viyatypedef
url="&url";
run;
%if &mdebug=1 %then %put DEBUG: &SYSMACRONAME &=url
&=SYS_PROCHTTP_STATUS_CODE &=SYS_PROCHTTP_STATUS_PHRASE;
%if (&SYS_PROCHTTP_STATUS_CODE ne 200) %then %do;
/* To avoid a breaking change, exit early if the request failed.
The calling process will proceed with empty requested macro variables. */
%put INFO: &sysmacroname A response was not returned.;
filename &viyatypedef clear;
%return;
%end;
%if &mdebug=1 %then %do;
data _null_;
infile &viyatypedef;
input;
put "DEBUG: &SYSMACRONAME" _infile_;
run;
%end;
/* Convert the content of that JSON into SAS datasets */
/* First prepare a new WORK-based folder to receive the datasets */
%local jsonworkfolder jsonlib opt_dlcreatedir;
%let jsonworkfolder=%sysfunc(pathname(work))/%mf_getuniquename(prefix=json_);
%let jsonlib=%mf_getuniquelibref(prefix=json);
/* And point a libname at it */
%let opt_dlcreatedir = %sysfunc(getoption(dlcreatedir));
options dlcreatedir; libname &jsonlib "&jsonworkfolder"; options &opt_dlcreatedir;
/* Read the json output once and copy datasets to its work folder */
%local libref1;
%let libref1=%mf_getuniquelibref();
libname &libref1 JSON fileref=&viyatypedef automap=create;
proc copy in=&libref1 out=&jsonlib; run;
/* Populate typeDefName, if requested */
%if (not %mf_isBlank(&typeDefNameVar)) %then %do;
%let &typeDefNameVar = %mf_getvalue(&jsonlib..alldata,value,filter=%quote(p1="items" and p2="name"));
%if &mdebug=1 %then %put DEBUG: &SYSMACRONAME &=typeDefNameVar &typeDefNameVar=&&&typeDefNameVar;
%end;
/* Populate mediaType, if requested */
%if (not %mf_isBlank(&mediaTypeVar)) %then %do;
%let &mediaTypeVar = %mf_getvalue(&jsonlib..alldata,value,filter=%quote(p1="items" and p2="mediaType"));
%if &mdebug=1 %then %put DEBUG: &SYSMACRONAME &=mediaTypeVar &mediaTypeVar=&&&mediaTypeVar;
%end;
/* Populate properties macro variable, if requested */
%if not %mf_isBlank(&propertiesVar) %then %do;
/* Check for the items_properties table */
%if ( not %mf_existds(&jsonlib..ITEMS_PROPERTIES) ) %then %do;
%let &propertiesVar = %str();
%if &mdebug=1 %then %put DEBUG: &SYSMACRONAME - No Viya properties found for file suffix %str(%')&ext%str(%');
%end;
%else %do;
/* Properties potentially span multiple rows in the ITEMS_PROPERTIES table */
/* First remove some unwanted variables from the items_properties dataset. */
%let dsTemplate=%mf_getuniquename(prefix=dsTemplate_);
data work.&dsTemplate;
stop;
set &jsonlib..ITEMS_PROPERTIES(drop=ordinal:);
run;
/* Retrieve the names of the remaining variables */
/* These are the names of the properties. */
%let varlist = %mf_getvarlist(work.&dsTemplate);
%if &mdebug %then %put DEBUG: &SYSMACRONAME &=varlist;
%let &propertiesVar = %quote({);
%let nvars = %sysfunc(countw(&varlist));
%do i = 1 %to &nvars;
/* Use the name of each variable in the dataset as the property 'key' */
%let key = %scan(&varlist,&i);
%let value = %mf_getvalue(&jsonlib..ITEMS_PROPERTIES,&key);
/* The data type determines if value should be quoted in the output*/
%if %mf_getvartype(&jsonlib..ITEMS_PROPERTIES,&key) = C %then %do;
%let value = "&value";
%end;
/* Transform the character '_', to '.' if found in the key */
%let key = %sysfunc(translate(&key,.,_));
/* Build the line to output */
%let line="&key": &value;
/* ...adding a comma to all but the final line in the object */
%if &i < &nvars %then %let line = &line%str(,);
%if &mdebug=1 %then %put DEBUG: &SYSMACRONAME line=%quote(&line);
%let &propertiesVar = &&&propertiesVar %quote(&line);
%end;
/* Close off the properties object */
%let &propertiesVar = &&&propertiesVar %quote(});
%if &mdebug=1 %then %put DEBUG: &SYSMACRONAME &=propertiesVar &propertiesVar=&&&propertiesVar;
%end;
%end;
%if &mdebug=0 %then %do;
proc datasets library=&jsonlib nolist kill; quit;
libname &jsonlib clear;
%end;
libname &libref1 clear;
filename &viyatypedef clear;
%mend;