diff options
author | José Bollo <jose.bollo@iot.bzh> | 2019-05-15 20:49:14 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2019-06-04 09:52:31 +0200 |
commit | 5b801a3e7b0465f88b785a155dd430ba09c56568 (patch) | |
tree | 82e06c5e13c7a4652170e17665f74496539a7022 /conf/unit/generate-unit-conf | |
parent | a5cf62686366f4a69becf62aa4d953e034c9bee4 (diff) |
afm-unit.conf: Refactor its generation
The process of generating the file /etc/afm-unit.conf
had be reworked to be more straight forward.
Before that commit, a manual operation (a "make") had
to be done before committing the repository. This was
not efficient, error prone and kept temporary files in
conf.
That commit changes it by calling m4 through cmake.
Bug-AGL: SPEC-2436
Change-Id: Ia32a810286471dde8a01387d157e33277d67411d
Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'conf/unit/generate-unit-conf')
-rw-r--r-- | conf/unit/generate-unit-conf/Makefile | 20 | ||||
-rw-r--r-- | conf/unit/generate-unit-conf/afm-unit | 109 | ||||
-rw-r--r-- | conf/unit/generate-unit-conf/binder.inc | 51 | ||||
-rw-r--r-- | conf/unit/generate-unit-conf/macros.inc | 67 | ||||
-rw-r--r-- | conf/unit/generate-unit-conf/provided-api.inc | 56 | ||||
-rw-r--r-- | conf/unit/generate-unit-conf/provided-binding.inc | 25 | ||||
-rw-r--r-- | conf/unit/generate-unit-conf/service.inc | 133 |
7 files changed, 0 insertions, 461 deletions
diff --git a/conf/unit/generate-unit-conf/Makefile b/conf/unit/generate-unit-conf/Makefile deleted file mode 100644 index 51cb9c8..0000000 --- a/conf/unit/generate-unit-conf/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -.PHONY: all - -MAIN = afm-unit - -FILES = $(MAIN) $(shell ls *.inc) Makefile - -DIR = .. - -D = -DAGL_DEVEL - -all: $(DIR)/afm-unit.conf.in $(DIR)/afm-unit-debug.conf.in - -$(DIR)/afm-unit.conf.in: $(FILES) - @echo generating $@ - @m4 $< | sed '/^[ \t]*\\*[ \t]*$$/d' > $@ - -$(DIR)/afm-unit-debug.conf.in: $(FILES) - @echo generating $@ - @m4 $D $< | sed '/^[ \t]*\\*[ \t]*$$/d' > $@ - diff --git a/conf/unit/generate-unit-conf/afm-unit b/conf/unit/generate-unit-conf/afm-unit deleted file mode 100644 index 2a91067..0000000 --- a/conf/unit/generate-unit-conf/afm-unit +++ /dev/null @@ -1,109 +0,0 @@ -divert(-1) --------------------------------------------------------------------------------- -dnl vim: set filetype=sysctl.conf.m4 syntax=sysctl.conf.m4: -include(macros.inc) --- Set the comment character of m4 to ; instead of # --- This is needed for substitution within lines starting with # -changecom( ';') -divert(0)dnl -;------------------------------------------------------------------------------- -; File: -; -; afm-unit.conf -; -; Mode: -; -; ON_AGL_DEVEL(DEVEL, RELEASE) -; -; Role: -; -; Configure how installation of widget produces unit files for systemd -; -; Processing and format: -; -; 1. File load -; -; Lines beginning with ; are firstly removed -; -; 2. File instantiation -; -; Mustache (extended) substitutions are applied using JSON -; data deduced from config.xml file of the widget. -; -; 3. Extraction of units -; -; Extract produced units, pack it (remove empty lines and directives) -; -; Directives: -; -; Any directive occupy one whole line starting with % -; -; - %nl -; -; produce an empty line at the end -; -; - %begin systemd-unit -; - %end systemd-unit -; -; delimit the produced unit -; -; - %systemd-unit user -; - %systemd-unit system -; -; tells the kind of unit (user/system) -; -; - %systemd-unit service NAME -; - %systemd-unit socket NAME -; -; gives the name and type of the unit -; -; - %systemd-unit wanted-by NAME -; -; tells to install a link to unit in the wants of NAME -; -; Setting variables: -; -; AFM uses the feature of systemd that completely ignores options prefixed -; with X- -; -; Consequently, options starting with X-AFM- are recorded as public data -; about the application and options starting starting with X-AFM-- are -; recorded as private data. -; -; Examples: -; -; X-AFM-description={{description}} -; -; Records the description of the unit in the field "description" -; of both the public and private object describing the unit. -; -; X-AFM--wgtdir={{:#metadata.install-dir}} -; -; Records the installation directory path in the field "wgtdir" -; of the private object only. -; -;------------------------------------------------------------------------------- -;---- F O R E A C H T A R G E T ---- -;------------------------------------------------------------------------------- -{{#targets}} -;------------------------------------------------------------------------------- -include(service.inc) -;------------------------------------------------------------------------------- -;---- F O R E A C H P R O V I D E D A P I S ---- -;------------------------------------------------------------------------------- -{{#provided-api}} -{{#value=ws|auto}} -include(provided-api.inc) -{{/value=ws|auto}} -{{/provided-api}} -;------------------------------------------------------------------------------- -;---- F O R E A C H P R O V I D E D B I N D I N G ---- -;------------------------------------------------------------------------------- -{{#provided-binding}} -include(provided-binding.inc) -{{/provided-binding}} -;------------------------------------------------------------------------------- -{{/targets}} -;------------------------------------------------------------------------------- -; End of file afm-unit.conf mode ON_AGL_DEVEL(DEVEL, RELEASE) -;------------------------------------------------------------------------------- diff --git a/conf/unit/generate-unit-conf/binder.inc b/conf/unit/generate-unit-conf/binder.inc deleted file mode 100644 index 30c25d5..0000000 --- a/conf/unit/generate-unit-conf/binder.inc +++ /dev/null @@ -1,51 +0,0 @@ -dnl vim: set filetype=sysctl.conf.m4 syntax=sysctl.conf.m4: - -IF_AGL_DEVEL -X-AFM-http-port={{:#metatarget.http-port}} -ELSE -IF_NOT_CONTENT(application/vnd.agl.service) -X-AFM--http-port={{:#metatarget.http-port}} -ENDIF -ENDIF - -Type=notify -ExecStart=/usr/bin/afb-daemon \ - --name afbd-TARGET \ - --rootdir={{:#metadata.install-dir}} \ - --workdir=APP_DATA_DIR/{{id}} \ -IF_AGL_DEVEL \ - --verbose \ - --verbose \ - --monitoring \ - --port={{:#metatarget.http-port}} \ - --token=HELLO \ - --roothttp=ON_CONTENT(application/vnd.agl.service, ., ON_PERM(:public:no-htdocs, ., htdocs)) \ -ELSE \ - IF_CONTENT(application/vnd.agl.service) \ - --no-httpd \ - ELSE \ - --port={{:#metatarget.http-port}} \ - --random-token \ - --roothttp=ON_PERM(:public:no-htdocs, ., htdocs) \ - ENDIF \ -ENDIF \ - ON_PERM(:public:applications:read, --alias=/icons:{{:#metadata.icons-dir}}) \ - {{#required-api}} \ - ON_VALUE(auto|ws, --ws-client=unix:API_PATH_WS/{{name}}) \ - ON_VALUE(dbus, --dbus-client={{name}}) \ - ON_VALUE(cloud, --cloud-client={{name}}) \ - ON_VALUE(local, --binding={{:#metadata.install-dir}}/{{name}}) \ - ON_VALUE(tcp, --ws-client=tcp:{{name}}) \ - {{/required-api}} \ - {{#required-binding}} \ - ON_VALUE(local, --binding={{:#metadata.install-dir}}/{{name}}) \ - ON_VALUE(extern, --binding=API_PATH_LINK/{{name}}) \ - {{/required-binding}} \ - {{#provided-api}} \ - ON_VALUE(auto|ws, --ws-server=sd:{{name}}) \ - ON_VALUE(dbus, --dbus-server={{name}}) \ - ON_VALUE(tcp, --ws-server=tcp:{{name}}) \ - {{/provided-api}} \ - ON_CONTENT(text/html, --exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t) \ - ON_CONTENT(application/vnd.agl.native, --exec {{:#metadata.install-dir}}/{{content.src}} @p @t) - diff --git a/conf/unit/generate-unit-conf/macros.inc b/conf/unit/generate-unit-conf/macros.inc deleted file mode 100644 index a764765..0000000 --- a/conf/unit/generate-unit-conf/macros.inc +++ /dev/null @@ -1,67 +0,0 @@ -dnl vim: set filetype=sysctl.conf.m4 syntax=sysctl.conf.m4: --------------------------------------------------------------------------------- --- GLOBAL IMPORTANT DEFINITIONS --------------------------------------------------------------------------------- -define( `X_EMITS', 1) -define( `X_DIVERTS', `divert(eval(-!X_EMITS()))') -define( `X_PUSH_DIVERTS', `pushdef(`X_EMITS', eval(X_EMITS() && $1))X_DIVERTS()') - -define( `X_IF', `pushdef(`X_COND', $1)X_PUSH_DIVERTS($1)') -define( `X_ELSE', `popdef(`X_EMITS')X_PUSH_DIVERTS(eval(!X_COND))') -define( `X_ELIF', `X_ELSE()X_IF($1)') -define( `X_ENDIF', `popdef(`X_EMITS')popdef(`X_COND')X_DIVERTS()') - -define( `IF', `pushdef(`ELSE',`X_ELSE()')pushdef(`ELIF',`X_ELIF($1)')pushdef(`ENDIF',`X_ENDIF()popdef(`ELSE',`ELIF',`ENDIF')')X_IF($1)') --------------------------------------------------------------------------------- --- MUSTACH SPECIFIC DEFINITIONS --------------------------------------------------------------------------------- -define( `MUSTACH_ON', `ifelse(`$2',,,`{{#$1}}`$2'{{/$1}}')ifelse(`$3',,,`{{^$1}}`$3'{{/$1}}')') -define( `MUSTACH_IF', `{{#$1}}pushdef(`ELSE',`{{/$1}}{{^$1}}')pushdef(`ENDIF',`{{/$1}}popdef(`ELSE',`ENDIF')')') -define( `MUSTACH_IF_NOT', `{{^$1}}pushdef(`ELSE',`{{/$1}}{{#$1}}')pushdef(`ENDIF',`{{/$1}}popdef(`ELSE',`ENDIF')')') --------------------------------------------------------------------------------- --- CONDITIONAL HELPERS --------------------------------------------------------------------------------- -define( `PERM', `@afm_prefix@permission:$1') -define( `REQPERM', `required-permission.PERM($1)') - -define( `ON_PERM', `MUSTACH_ON(REQPERM($1),$2,$3)') -define( `IF_PERM', `MUSTACH_IF(REQPERM($1))') -define( `IF_NOT_PERM', `MUSTACH_IF_NOT(REQPERM($1))') - -define( `ON_CONTENT', `MUSTACH_ON(content.type=$1,$2,$3)') -define( `IF_CONTENT', `MUSTACH_IF(content.type=$1)') -define( `IF_NOT_CONTENT', `MUSTACH_IF_NOT(content.type=$1)') - -define( `ON_VALUE', `MUSTACH_ON(value=$1,$2,$3)') -define( `IF_VALUE', `MUSTACH_IF(value=$1)') -define( `IF_NOT_VALUE', `MUSTACH_IF_NOT(value=$1)') --------------------------------------------------------------------------------- --- AFM DEFINITION --------------------------------------------------------------------------------- --- NOTE: --- when home screen will use real ids --- use TARGET={{:id}}--{{:ver}}--{{:#target}} --- instead of TARGET={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}} --------------------------------------------------------------------------------- -define( `TARGET', `{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}') -define( `NEWTARGET', `{{:id}}--{{:ver}}--{{:#target}}') -define( `UNIT_NAME_BASE', `afm-ON_PERM(`:public:hidden', `service', `appli')-NEWTARGET') -define( `UNIT_NAME_SERVICE', `UNIT_NAME_BASE@%i.service') -define( `UNIT_NAME_API_BASE', `afm-api-$1') -define( `UNIT_NAME_API_SERVICE', `UNIT_NAME_API_BASE($1)@$2.service') -define( `UNIT_NAME_API_SOCKET', `UNIT_NAME_API_BASE($1)@$2.socket') -define( `UNIT_NAME_BINDING_BASE', `afm-link-$1') -define( `UNIT_NAME_BINDING_SERVICE', `UNIT_NAME_BINDING_BASE($1)@$2.service') -define( `APP_DATA_DIR', `/home/%i/app-data') -define( `USER_RUN_DIR', `@afm_users_rundir@/%i') -define( `DEBUGGING_DIR', `@afm_platform_rundir@/debug') -define( `API_PATH', `USER_RUN_DIR/apis') -define( `API_PATH_WS', `API_PATH/ws') -define( `API_PATH_LINK', `API_PATH/link') --------------------------------------------------------------------------------- --- AGL_DEVEL SPECIFIC PARTS --------------------------------------------------------------------------------- -define( `ON_AGL_DEVEL', `ifdef(`AGL_DEVEL', $1, $2)') -define( `ON_NOT_AGL_DEVEL', `ifdef(`AGL_DEVEL', $2, $1)') -define( `IF_AGL_DEVEL', `IF(ON_AGL_DEVEL(1,0))') -define( `IF_NOT_AGL_DEVEL', `IF(ON_AGL_DEVEL(0,1))') diff --git a/conf/unit/generate-unit-conf/provided-api.inc b/conf/unit/generate-unit-conf/provided-api.inc deleted file mode 100644 index bdee6c9..0000000 --- a/conf/unit/generate-unit-conf/provided-api.inc +++ /dev/null @@ -1,56 +0,0 @@ -dnl vim: set filetype=sysctl.conf.m4 syntax=sysctl.conf.m4: -;------------------------------------------------------------------------------- -;---- T H E S E R V I C E O F T H E A P I ---- -;------------------------------------------------------------------------------- -%begin systemd-unit - -# auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}} - -%systemd-unit system -%systemd-unit service UNIT_NAME_API_BASE({{name}})@ - -[Unit] -Description=Provides api {{name}} for user %i -X-AFM-API-TYPE={{value}} - -Requires=afm-user-setup@%i.service -After=afm-user-setup@%i.service - -Requires=UNIT_NAME_API_BASE({{name}})@%i.socket -After=UNIT_NAME_API_BASE({{name}})@%i.socket - -[Service] -Type=oneshot -RemainAfterExit=yes -ExecStart=/bin/true - -%end systemd-unit - -;------------------------------------------------------------------------------- -;---- T H E S O C K E T O F T H E A P I ---- -;------------------------------------------------------------------------------- - -%begin systemd-unit - -# auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}} - -%systemd-unit system -%systemd-unit socket UNIT_NAME_API_BASE({{name}})@ -[Unit] -Description=Provides websocket api {{name}} for user %i -Requires=afm-user-setup@%i.service -After=afm-user-setup@%i.service -DefaultDependencies=no - -[Socket] -SmackLabel=* -SmackLabelIPIn=System -SmackLabelIPOut=System -ListenStream=API_PATH_WS/{{name}} -FileDescriptorName={{name}} -Service=UNIT_NAME_SERVICE - -%end systemd-unit - - - diff --git a/conf/unit/generate-unit-conf/provided-binding.inc b/conf/unit/generate-unit-conf/provided-binding.inc deleted file mode 100644 index 3737126..0000000 --- a/conf/unit/generate-unit-conf/provided-binding.inc +++ /dev/null @@ -1,25 +0,0 @@ -dnl vim: set filetype=sysctl.conf.m4 syntax=sysctl.conf.m4: -;------------------------------------------------------------------------------- -;---- T H E S E R V I C E O F T H E B I N D I N G ---- -;------------------------------------------------------------------------------- -%begin systemd-unit - -# auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}} - -%systemd-unit system -%systemd-unit service UNIT_NAME_BINDING_BASE({{name}})@ - -[Unit] -Description=Provides binding {{name}} for user %i - -Requires=afm-user-setup@%i.service -After=afm-user-setup@%i.service - -[Service] -Type=oneshot -RemainAfterExit=yes -ExecStart=/bin/ln -sf {{:#metadata.install-dir}}/{{value}} API_PATH_LINK/{{name}} - -%end systemd-unit - - diff --git a/conf/unit/generate-unit-conf/service.inc b/conf/unit/generate-unit-conf/service.inc deleted file mode 100644 index 88c1454..0000000 --- a/conf/unit/generate-unit-conf/service.inc +++ /dev/null @@ -1,133 +0,0 @@ -dnl vim: set filetype=sysctl.conf.m4 syntax=sysctl.conf.m4: -;------------------------------------------------------------------------------- -;---- M A I N P A R T O F T H E S E R V I C E ---- -;------------------------------------------------------------------------------- -%begin systemd-unit - -# auto generated by wgtpkg-unit for {{:id}} version {{:version}} target {{:#target}} of {{:idaver}} -%nl - -%systemd-unit system -%systemd-unit service UNIT_NAME_BASE@ - -[Unit] -Description={{description}} -X-AFM-description={{description}} -X-AFM-name={{name.content}} -X-AFM-shortname={{name.short}} -X-AFM-id=TARGET -X-AFM-version={{:version}} -X-AFM-author={{author.content}} -X-AFM-author-email={{author.email}} -X-AFM-width={{width}} -X-AFM-height={{height}} -{{#icon}} -X-AFM-icon={{:#metadata.install-dir}}/{{:src}} -{{/icon}} -X-AFM--ID={{:id}} -X-AFM--target-name={{:#target}} -X-AFM--content={{content.src}} -X-AFM--type={{content.type}} -X-AFM--wgtdir={{:#metadata.install-dir}} -X-AFM--workdir=APP_DATA_DIR/{{:id}} -X-AFM--visibility=ON_PERM(`:public:hidden', `hidden', `visible') -%nl - -Requires=afm-user-session@%i.target -After=user@%i.service -After=Network.target - -# Adds check to smack -ConditionSecurity=smack -%nl - -# Automatic bound to required api -{{#required-binding}} -{{#value=extern}} -BindsTo=UNIT_NAME_BINDING_SERVICE({{name}},%i) -After=UNIT_NAME_BINDING_SERVICE({{name}},%i) -{{/value=extern}} -{{/required-binding}} -{{#required-api}} -{{#value=auto|ws}} -BindsTo=UNIT_NAME_API_SERVICE({{name}},%i) -After=UNIT_NAME_API_SERVICE({{name}},%i) -{{/value=auto|ws}} -{{/required-api}} -{{#provided-api}} -{{#value=ws|auto}} -Requires=UNIT_NAME_API_SOCKET({{name}},%i) -After=UNIT_NAME_API_SOCKET({{name}},%i) -{{/value=ws|auto}} -{{/provided-api}} - -%nl - -[Service] -EnvironmentFile=-@afm_confdir@/unit.env.d/* -EnvironmentFile=-@afm_confdir@/widget.env.d/{{:id}}/* -SmackProcessLabel=User::App::{{:id}} -SuccessExitStatus=0 SIGKILL - -User=%i -Slice=user-%i.slice - -CapabilityBoundingSet= -#AmbientCapabilities= - -ON_PERM(:platform:no-oom, OOMScoreAdjust=-500) -ON_PERM(:partner:real-time, IOSchedulingClass=realtime) -ON_PERM(:public:display, SupplementaryGroups=display) -ON_PERM(:public:syscall:clock, , SystemCallFilter=~@clock) -%nl - -WorkingDirectory=-APP_DATA_DIR/{{:id}} -ExecStartPre=/bin/mkdir -p APP_DATA_DIR/{{:id}} -Environment=AFM_ID=TARGET -Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}} -Environment=AFM_WORKDIR=APP_DATA_DIR/{{:id}} -Environment=AFM_WSAPI_DIR=API_PATH_WS -Environment=PATH=/usr/sbin:/usr/bin:/sbin:/bin:{{:#metadata.install-dir}}/bin -Environment=LD_LIBRARY_PATH={{:#metadata.install-dir}}/lib -Environment=XDG_DATA_HOME=APP_DATA_DIR/{{:id}} -Environment=XDG_CONFIG_HOME=APP_DATA_DIR/{{:id}} -Environment=XDG_CACHE_HOME=APP_DATA_DIR/{{:id}} -Environment=XDG_RUNTIME_DIR=USER_RUN_DIR -Environment=DBUS_SESSION_BUS_ADDRESS=unix:path=USER_RUN_DIR/bus - -IF_AGL_DEVEL -; Needed to enable debug -EnvironmentFile=-DEBUGGING_DIR/TARGET.env -ENDIF - -SyslogIdentifier=afbd-TARGET -StandardInput=null -StandardOutput=journal -StandardError=journal - -;------------------------------------------------------------------------------- -;---- text/html application/vnd.agl.native application/vnd.agl.service ---- -;------------------------------------------------------------------------------- -{{#content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}} -include(binder.inc) -{{/content.type=text/html|application/vnd.agl.native|application/vnd.agl.service}} - -;------------------------------------------------------------------------------- -;---- application/x-executable ---- -;------------------------------------------------------------------------------- -{{#content.type=application/x-executable}} -ExecStart={{:#metadata.install-dir}}/{{content.src}} -{{/content.type=application/x-executable}} - -IF_PERM(:system:run-by-default) -;------------------------------------------------------------------------------- -; auto start -;------------------------------------------------------------------------------- -[Install] -WantedBy=afm-user-session@.target -%systemd-unit wanted-by afm-user-session@.target -ENDIF - -%end systemd-unit - - |