Re: [gentoo-portage-dev] New proposed modular sync system

[Brian Dolbec]

On Thu, 09 Jan 2014 09:33:51 -0800
Brian Dolbec <dolsen@g.o> wrote:

>
> I have started a Proposals sub-page under the Portage project page in
> the wiki.  It has a link to a diagram I made showing how the plug-in
> system is laid out.  This thread will be used to discuss the proposal
> and the details needed for the module_spec dictionary that is used to
> provide the manager with the details of what a module provides,
> options, etc..
>
> For a working example of the system in action, just try out emaint -h,
> and some other actions it provides.  Then move one of it's modules out
> of the the emaint/modules/ directory and re-try emaint -h.  You will
> see the options for that module and it's actions are no longer
> available. No code editing was required, no errors occurred,...  Put
> it back, retry...
>
> The modular sync system I propose would re-use that plug-in manager to
> interface the sync manager code with the modules that perform the sync
> actions.  This sytem is easily extended with new modules for different
> transfer methods or VCS specific modules.
>

STATUS UPDATE:

I have pushed the plugin-sync branch to the main portage.git repo on
g.o.g.o [1].  It has working and tested code for the rsync and git
modules.  The CVS module I have not yet tested or done any debugging on.

First off, let me state that this is only minimally changed code to
make it function.  It is by no means ready for any code review other
than for general program structure and the data that we need/want to
pass between the controller and the modules.

I have updated the Proposal page [2] with more things to do as well as
some insights I discovered during the initial porting.

Next up for discussion is what additional functionality should a module
supply?

I think it should provide a list or dictionary of the repos.conf
variables it needs or uses.  I also think that the module should
provide a function for validating the conf variables meet some minimum
standard/obvious error checking.

For a more involved example of the types of information that can be
passed through the module_spec see the working emaint logs module file
[3].  The information required/provided does not affect the plugin
system.  It is a standard set up by the controller and the modules
requirements.

So, please look over the code, avoid commenting on the poor code
quality just yet.  Before I work on cleaning up/improving the code I
wanted to establish what we feel the requirements should be.



[1]
http://git.overlays.gentoo.org/gitweb/?p=proj/portage.git;a=shortlog;h=refs/heads/plugin-sync
[2] https://wiki.gentoo.org/wiki/Project:Portage/Proposals
[3]
http://git.overlays.gentoo.org/gitweb/?p=proj/portage.git;a=blob;f=pym/portage/emaint/modules/logs/__init__.py;h=0407efe2bef19f2f815c53790e1ea790366b9967;hb=HEAD


-- 
Brian Dolbec <dolsen>