From 5fc53333f58ce9dc2b1c7128ee93384385dd3c47 Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Mon, 24 Sep 2018 22:19:25 +0200 Subject: [PATCH] now pre action are only executed if dotfile is installed (#59) --- dotdrop/dotdrop.py | 7 +-- dotdrop/installer.py | 40 ++++++++++------ tests-ng/actions-pre.sh | 104 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 133 insertions(+), 18 deletions(-) create mode 100755 tests-ng/actions-pre.sh diff --git a/dotdrop/dotdrop.py b/dotdrop/dotdrop.py index e087348..217670d 100644 --- a/dotdrop/dotdrop.py +++ b/dotdrop/dotdrop.py @@ -93,6 +93,7 @@ def install(opts, conf, temporary=False): debug=opts['debug'], totemp=tmpdir) installed = [] for dotfile in dotfiles: + preactions = [] if dotfile.actions and Cfg.key_actions_pre in dotfile.actions: for action in dotfile.actions[Cfg.key_actions_pre]: if opts['dry']: @@ -100,11 +101,11 @@ def install(opts, conf, temporary=False): else: if opts['debug']: LOG.dbg('executing pre action {}'.format(action)) - action.execute() + preactions.append(action) if opts['debug']: LOG.dbg('installing {}'.format(dotfile)) if hasattr(dotfile, 'link') and dotfile.link: - r = inst.link(t, dotfile.src, dotfile.dst) + r = inst.link(t, dotfile.src, dotfile.dst, actions=preactions) else: src = dotfile.src tmp = None @@ -113,7 +114,7 @@ def install(opts, conf, temporary=False): if not tmp: continue src = tmp - r = inst.install(t, src, dotfile.dst) + r = inst.install(t, src, dotfile.dst, actions=preactions) if tmp: tmp = os.path.join(opts['dotpath'], tmp) if os.path.exists(tmp): diff --git a/dotdrop/installer.py b/dotdrop/installer.py index 022dffb..246e347 100644 --- a/dotdrop/installer.py +++ b/dotdrop/installer.py @@ -33,7 +33,7 @@ class Installer: self.comparing = False self.log = Logger() - def install(self, templater, src, dst): + def install(self, templater, src, dst, actions=[]): """install the src to dst using a template""" src = os.path.join(self.base, os.path.expanduser(src)) dst = os.path.expanduser(dst) @@ -46,27 +46,27 @@ class Installer: if self.debug: self.log.dbg('install {} to {}'.format(src, dst)) if os.path.isdir(src): - return self._handle_dir(templater, src, dst) - return self._handle_file(templater, src, dst) + return self._handle_dir(templater, src, dst, actions=actions) + return self._handle_file(templater, src, dst, actions=actions) - def link(self, templater, src, dst): + def link(self, templater, src, dst, actions=[]): """set src as the link target of dst""" src = os.path.join(self.base, os.path.expanduser(src)) dst = os.path.expanduser(dst) if self.totemp: - return self.install(templater, src, dst) + return self.install(templater, src, dst, actions=actions) if Templategen.is_template(src): if self.debug: self.log.dbg('dotfile is a template') self.log.dbg('install to {} and symlink'.format(self.workdir)) tmp = self._pivot_path(dst, self.workdir, striphome=True) - if not self.install(templater, src, tmp): + if not self.install(templater, src, tmp, actions=actions): return [] src = tmp - return self._link(src, dst) + return self._link(src, dst, actions=actions) - def _link(self, src, dst): + def _link(self, src, dst, actions=[]): """set src as a link target of dst""" if os.path.lexists(dst): if os.path.realpath(dst) == os.path.realpath(src): @@ -93,11 +93,12 @@ class Installer: if not self._create_dirs(base): self.log.err('creating directory for \"{}\"'.format(dst)) return [] + self._exec_pre_actions(actions) os.symlink(src, dst) self.log.sub('linked \"{}\" to \"{}\"'.format(dst, src)) return [(src, dst)] - def _handle_file(self, templater, src, dst): + def _handle_file(self, templater, src, dst, actions=[]): """install src to dst when is a file""" if self.debug: self.log.dbg('generate template for {}'.format(src)) @@ -113,7 +114,7 @@ class Installer: self.log.err('source dotfile does not exist: \"{}\"'.format(src)) return [] st = os.stat(src) - ret = self._write(dst, content, st.st_mode) + ret = self._write(dst, content, st.st_mode, actions=actions) if ret < 0: self.log.err('installing \"{}\" to \"{}\"'.format(src, dst)) return [] @@ -127,18 +128,21 @@ class Installer: return [(src, dst)] return [] - def _handle_dir(self, templater, src, dst): + def _handle_dir(self, templater, src, dst, actions=[]): """install src to dst when is a directory""" ret = [] - self._create_dirs(dst) + if not self._create_dirs(dst): + return [] # handle all files in dir for entry in os.listdir(src): f = os.path.join(src, entry) if not os.path.isdir(f): - res = self._handle_file(templater, f, os.path.join(dst, entry)) + res = self._handle_file(templater, f, os.path.join(dst, entry), + actions=actions) ret.extend(res) else: - res = self._handle_dir(templater, f, os.path.join(dst, entry)) + res = self._handle_dir(templater, f, os.path.join(dst, entry), + actions=actions) ret.extend(res) return ret @@ -149,7 +153,7 @@ class Installer: cur = f.read() return cur == content - def _write(self, dst, content, rights): + def _write(self, dst, content, rights, actions=[]): """write content to file return 0 for success, 1 when already exists @@ -174,6 +178,7 @@ class Installer: return -1 if self.debug: self.log.dbg('write content to {}'.format(dst)) + self._exec_pre_actions(actions) try: with open(dst, 'wb') as f: f.write(content) @@ -213,6 +218,11 @@ class Installer: sub = path.lstrip(os.sep) return os.path.join(newdir, sub) + def _exec_pre_actions(self, actions): + """execute pre-actions if any""" + for action in actions: + action.execute() + def _install_to_temp(self, templater, src, dst, tmpdir): """install a dotfile to a tempdir""" tmpdst = self._pivot_path(dst, tmpdir) diff --git a/tests-ng/actions-pre.sh b/tests-ng/actions-pre.sh new file mode 100755 index 0000000..41f40e2 --- /dev/null +++ b/tests-ng/actions-pre.sh @@ -0,0 +1,104 @@ +#!/usr/bin/env bash +# author: deadc0de6 (https://github.com/deadc0de6) +# Copyright (c) 2017, deadc0de6 +# +# test pre action execution +# returns 1 in case of error +# + +# exit on first error +set -e + +# all this crap to get current path +rl="readlink -f" +if ! ${rl} "${0}" >/dev/null 2>&1; then + rl="realpath" + + if ! hash ${rl}; then + echo "\"${rl}\" not found !" && exit 1 + fi +fi +cur=$(dirname "$(${rl} "${0}")") + +#hash dotdrop >/dev/null 2>&1 +#[ "$?" != "0" ] && echo "install dotdrop to run tests" && exit 1 + +#echo "called with ${1}" + +# dotdrop path can be pass as argument +ddpath="${cur}/../" +[ "${1}" != "" ] && ddpath="${1}" +[ ! -d ${ddpath} ] && echo "ddpath \"${ddpath}\" is not a directory" && exit 1 + +export PYTHONPATH="${ddpath}:${PYTHONPATH}" +bin="python3 -m dotdrop.dotdrop" + +echo "dotdrop path: ${ddpath}" +echo "pythonpath: ${PYTHONPATH}" + +# get the helpers +source ${cur}/helpers + +echo "RUNNING $(basename $BASH_SOURCE)" + +################################################################ +# this is the test +################################################################ + +# the action temp +tmpa=`mktemp -d` +# the dotfile source +tmps=`mktemp -d` +mkdir -p ${tmps}/dotfiles +# the dotfile destination +tmpd=`mktemp -d` + +# create the config file +cfg="${tmps}/config.yaml" + +cat > ${cfg} << _EOF +actions: + pre: + preaction: echo 'pre' > ${tmpa}/pre + nakedaction: echo 'naked' > ${tmpa}/naked +config: + backup: true + create: true + dotpath: dotfiles +dotfiles: + f_abc: + dst: ${tmpd}/abc + src: abc + actions: + - preaction + - nakedaction +profiles: + p1: + dotfiles: + - f_abc +_EOF +cat ${cfg} + +# create the dotfile +echo "test" > ${tmps}/dotfiles/abc + +# install +cd ${ddpath} | ${bin} install -f -c ${cfg} -p p1 + +# checks +[ ! -e ${tmpa}/pre ] && exit 1 +grep pre ${tmpa}/pre >/dev/null +[ ! -e ${tmpa}/naked ] && exit 1 +grep naked ${tmpa}/naked >/dev/null + +# remove the pre action result and re-run +rm ${tmpa}/pre + +cd ${ddpath} | ${bin} install -f -c ${cfg} -p p1 +[ -e ${tmpa}/pre ] && exit 1 + +## CLEANING +rm -rf ${tmps} ${tmpd} ${tmpa} + +echo "OK" +exit 0