Extend commit plugin to send the transaction list (Fate#316203)

Added 2 new plugin methods COMMITBEGIN/COMMITEND passing the
TransactionStepList as JSON in the body. libzypp(plugin:commit)
version bumped to 1.

diff --git a/doc/autoinclude/Plugin-Commit.doc b/doc/autoinclude/Plugin-Commit.doc
index f8459fe..e03173e 100644 (file)
--- a/doc/autoinclude/Plugin-Commit.doc
+++ b/doc/autoinclude/Plugin-Commit.doc
@@ -7,7 +7,7 @@
 <HR><!-- ====================================================================== -->
 \section intro Introduction
 
-This is a statefull plugin executed during \ref zypp::ZYpp::commit. At the beginning of a commit all plugins found in \c /usr/lib/zypp/plugins/commit are launched. The plugins will receive messages as commit proceeds. Unless otherwise specified messages received need to be confirmed by sending an \c ACC message. Sending back an \c ERROR message execution of the plugin will be canceled.
+This is a statefull plugin executed during \ref zypp::ZYpp::commit. At the beginning of a commit all plugins found in \c /usr/lib/zypp/plugins/commit are launched. The plugins will receive messages as commit proceeds. Unless otherwise specified messages received need to be confirmed by sending an \c ACC message. Sending back an unexpected or \c ERROR message execution of the plugin will be canceled.
 
 If you have e.g. \c zypp-plugin-python installed a basic commit plugin could look like this:
 
@@ -52,6 +52,58 @@ Sent as 1st message after the plugin was launched. Prepare your plugin and send
 
 
 <HR><!-- ====================================================================== -->
+\section commitbegin COMMITBEGIN (added in v1)
+\verbatim
+COMMITBEGIN
+
+{
+"TransactionStepList": [ <TransactionStep>,... ]
+}
+^@
+\endverbatim
+Sent before installation actually starts. The body contains a JSON encoded object providing the \c TransactionStepList, basically the list of install/remove actions the the commit is going to perform. Each \c TransactionStep is encoded as JSON object:
+\verbatim
+<TransactionStep> = {
+  "type":     <TypeString>    # [optional]
+  "stage":    <StageString>   # [optional]
+  "solvable": <Solvable>
+}
+
+<TypeString> = <missing>      # ignore; implicit or non-package actions
+            | "-"            # remove
+            | "+"            # install
+            | "M"            # multi version install; install keeping the old version; e.g. kernel
+
+<StageString> = <missing>     # todo
+              | "ok"          # done
+              | "err"         # failed
+
+<Solvable> = {
+  "n": <string>               # name
+  "e": <number>               # epoch if not 0 [optional]
+  "v": <string>               # version
+  "r": <string>               # release
+  "a": <string>               # architecture
+}
+\endverbatim
+
+\see \ref zypp::sat::Transaction::Step
+
+<HR><!-- ====================================================================== -->
+\section commitend COMMITEND (added in v1)
+\verbatim
+COMMITEND
+
+{
+"TransactionStepList": [ <TransactionStep>,... ]
+}
+^@
+\endverbatim
+Sent at the end of commit. The body contains a JSON encoded object providing the final \c TransactionStepList. The \c StepStage indicates whether the action succeeded, failed or was skipped (still 'todo').
+
+\see \ref commitbegin
+
+<HR><!-- ====================================================================== -->
 \section pluginend PLUGINEND
 \verbatim
 PLUGINEND

diff --git a/libzypp.spec.cmake b/libzypp.spec.cmake
index da641f5..2e4db64 100644 (file)
--- a/libzypp.spec.cmake
+++ b/libzypp.spec.cmake
@@ -32,7 +32,7 @@ Obsoletes:      yast2-packagemanager
 
 # Features we provide (update doc/autoinclude/FeatureTest.doc):
 Provides:       libzypp(plugin) = 0
-Provides:       libzypp(plugin:commit) = 0
+Provides:       libzypp(plugin:commit) = 1
 Provides:       libzypp(plugin:services) = 0
 Provides:       libzypp(plugin:system) = 0
 Provides:       libzypp(plugin:urlresolver) = 0

diff --git a/zypp/target/TargetImpl.cc b/zypp/target/TargetImpl.cc
index 8ed7cfd..38730df 100644 (file)
--- a/zypp/target/TargetImpl.cc
+++ b/zypp/target/TargetImpl.cc
@@ -26,6 +26,7 @@
 #include "zypp/base/IOStream.h"
 #include "zypp/base/Functional.h"
 #include "zypp/base/UserRequestException.h"
+#include "zypp/base/Json.h"
 
 #include "zypp/ZConfig.h"
 #include "zypp/ZYppFactory.h"
@@ -64,6 +65,98 @@ using namespace std;
 namespace zypp
 { /////////////////////////////////////////////////////////////////
   ///////////////////////////////////////////////////////////////////
+  namespace json
+  {
+    // Lazy via template specialisation / should switch to overloading
+
+    template<>
+    inline std::string toJSON( const ZYppCommitResult::TransactionStepList & steps_r )
+    {
+      using sat::Transaction;
+      json::Array ret;
+
+      for ( const Transaction::Step & step : steps_r )
+       // ignore implicit deletes due to obsoletes and non-package actions
+       if ( step.stepType() != Transaction::TRANSACTION_IGNORE )
+         ret.add( step );
+
+      return ret.asJSON();
+    }
+
+    /** See \ref commitbegin on page \ref plugin-commit for the specs. */
+    template<>
+    inline std::string toJSON( const sat::Transaction::Step & step_r )
+    {
+      static const std::string strType( "type" );
+      static const std::string strStage( "stage" );
+      static const std::string strSolvable( "solvable" );
+
+      static const std::string strTypeDel( "-" );
+      static const std::string strTypeIns( "+" );
+      static const std::string strTypeMul( "M" );
+
+      static const std::string strStageDone( "ok" );
+      static const std::string strStageFailed( "err" );
+
+      static const std::string strSolvableN( "n" );
+      static const std::string strSolvableE( "e" );
+      static const std::string strSolvableV( "v" );
+      static const std::string strSolvableR( "r" );
+      static const std::string strSolvableA( "a" );
+
+      using sat::Transaction;
+      json::Object ret;
+
+      switch ( step_r.stepType() )
+      {
+       case Transaction::TRANSACTION_IGNORE:   /*empty*/ break;
+       case Transaction::TRANSACTION_ERASE:    ret.add( strType, strTypeDel ); break;
+       case Transaction::TRANSACTION_INSTALL:  ret.add( strType, strTypeIns ); break;
+       case Transaction::TRANSACTION_MULTIINSTALL: ret.add( strType, strTypeMul ); break;
+      }
+
+      switch ( step_r.stepStage() )
+      {
+       case Transaction::STEP_TODO:            /*empty*/ break;
+       case Transaction::STEP_DONE:            ret.add( strStage, strStageDone ); break;
+       case Transaction::STEP_ERROR:           ret.add( strStage, strStageFailed ); break;
+      }
+
+      {
+       IdString ident;
+       Edition ed;
+       Arch arch;
+       if ( sat::Solvable solv = step_r.satSolvable() )
+       {
+         ident = solv.ident();
+         ed    = solv.edition();
+         arch  = solv.arch();
+       }
+       else
+       {
+         // deleted package; post mortem data stored in Transaction::Step
+         ident = step_r.ident();
+         ed    = step_r.edition();
+         arch  = step_r.arch();
+       }
+
+       json::Object s {
+         { strSolvableN, ident.asString() },
+         { strSolvableV, ed.version() },
+         { strSolvableR, ed.release() },
+         { strSolvableA, arch.asString() }
+       };
+       if ( Edition::epoch_t epoch = ed.epoch() )
+         s.add( strSolvableE, epoch );
+
+       ret.add( strSolvable, s );
+      }
+
+      return ret.asJSON();
+    }
+  } // namespace json
+  ///////////////////////////////////////////////////////////////////
+  ///////////////////////////////////////////////////////////////////
   namespace target
   { /////////////////////////////////////////////////////////////////
 
@@ -73,8 +166,6 @@ namespace zypp
     class CommitPlugins : private base::NonCopyable
     {
       public:
-
-      public:
        /** Default ctor: Empty plugin list */
        CommitPlugins()
        {}
@@ -82,24 +173,31 @@ namespace zypp
        /** Dtor: Send PLUGINEND message and close plugins. */
        ~CommitPlugins()
        {
-         for_( it, _scripts.begin(), _scripts.end() )
+         if ( ! _scripts.empty() )
+           send( PluginFrame( "PLUGINEND" ) );
+         // ~PluginScript will disconnect all remaining plugins!
+       }
+
+       /** Whether no plugins are waiting */
+       bool empty() const
+       { return _scripts.empty(); }
+
+
+       /** Send \ref PluginFrame to all open plugins.
+        * Failed plugins are removed from the execution list.
+        */
+       void send( const PluginFrame & frame_r )
+       {
+         DBG << "+++++++++++++++ send " << frame_r << endl;
+         for ( auto it = _scripts.begin(); it != _scripts.end(); )
          {
-           MIL << "Unload plugin: " << *it << endl;
-           try {
-             it->send( PluginFrame( "PLUGINEND" ) );
-             PluginFrame ret( it->receive() );
-             if ( ! ret.isAckCommand() )
-             {
-               WAR << "Failed to unload plugin: Bad plugin response." << endl;
-             }
-             it->close();
-           }
-           catch( const zypp::Exception &  )
-           {
-             WAR << "Failed to unload plugin." << endl;
-           }
+           doSend( *it, frame_r );
+           if ( it->isOpen() )
+             ++it;
+           else
+             it = _scripts.erase( it );
          }
-         // _scripts dtor will disconnect all remaining plugins!
+         DBG << "--------------- send " << frame_r << endl;
        }
 
        /** Find and launch plugins sending PLUGINSTART message.
@@ -111,6 +209,7 @@ namespace zypp
        void load( const Pathname & path_r )
        {
          PathInfo pi( path_r );
+         DBG << "+++++++++++++++ load " << pi << endl;
          if ( pi.isDir() )
          {
            std::list<Pathname> entries;
@@ -137,33 +236,55 @@ namespace zypp
          {
            WAR << "Plugin path is neither dir nor file: " << pi << endl;
          }
+         DBG << "--------------- load " << pi << endl;
        }
 
       private:
+       /** Send \ref PluginFrame and expect valid answer (ACK|_ENOMETHOD).
+        * Upon invalid answer or error, close the plugin. and remove it from the
+        * execution list.
+        * \returns the received \ref PluginFrame (empty Frame upon Exception)
+        */
+       PluginFrame doSend( PluginScript & script_r, const PluginFrame & frame_r )
+       {
+         PluginFrame ret;
+
+         try {
+           script_r.send( frame_r );
+           ret = script_r.receive();
+         }
+         catch( const zypp::Exception & e )
+         { ZYPP_CAUGHT(e); }
+
+         if ( ! ( ret.isAckCommand() || ret.isEnomethodCommand() ) )
+         {
+           WAR << "Bad plugin response from " << script_r << endl;
+           WAR << dump(ret) << endl;
+           script_r.close();
+         }
+
+         return ret;
+       }
+
+       /** Launch a plugin sending PLUGINSTART message. */
        void doLoad( const PathInfo & pi_r )
        {
          MIL << "Load plugin: " << pi_r << endl;
          try {
+           PluginScript plugin( pi_r.path() );
+           plugin.open();
+
            PluginFrame frame( "PLUGINBEGIN" );
            if ( ZConfig::instance().hasUserData() )
              frame.setHeader( "userdata", ZConfig::instance().userData() );
 
-           PluginScript plugin( pi_r.path() );
-           plugin.open();
-           plugin.send( frame );
-           PluginFrame ret( plugin.receive() );
-           if ( ret.isAckCommand() )
-           {
+           doSend( plugin, frame );    // closes on error
+           if ( plugin.isOpen() )
              _scripts.push_back( plugin );
-           }
-           else
-           {
-             WAR << "Failed to load plugin: Bad plugin response." << endl;
-           }
          }
-         catch( const zypp::Exception &  )
+         catch( const zypp::Exception & e )
          {
-            WAR << "Failed to load plugin." << endl;
+            WAR << "Failed to load plugin " << pi_r << endl;
          }
        }
 
@@ -183,6 +304,16 @@ namespace zypp
     }
 
     ///////////////////////////////////////////////////////////////////
+    namespace
+    {
+      inline PluginFrame transactionPluginFrame( const std::string & command_r, ZYppCommitResult::TransactionStepList & steps_r )
+      {
+       return PluginFrame( command_r, json::Object {
+         { "TransactionStepList", steps_r }
+       }.asJSON() );
+      }
+    } // namespace
+    ///////////////////////////////////////////////////////////////////
 
     /** \internal Manage writing a new testcase when doing an upgrade. */
     void writeUpgradeTestcase()
@@ -1101,6 +1232,32 @@ namespace zypp
       MIL << "TargetImpl::commit(<pool>, " << policy_r << ")" << endl;
 
       ///////////////////////////////////////////////////////////////////
+      // Compute transaction:
+      ///////////////////////////////////////////////////////////////////
+      ZYppCommitResult result( root() );
+      result.rTransaction() = pool_r.resolver().getTransaction();
+      result.rTransaction().order();
+      // steps: this is our todo-list
+      ZYppCommitResult::TransactionStepList & steps( result.rTransactionStepList() );
+      if ( policy_r.restrictToMedia() )
+      {
+       // Collect until the 1st package from an unwanted media occurs.
+        // Further collection could violate install order.
+       MIL << "Restrict to media number " << policy_r.restrictToMedia() << endl;
+       for_( it, result.transaction().begin(), result.transaction().end() )
+       {
+         if ( makeResObject( *it )->mediaNr() > 1 )
+           break;
+         steps.push_back( *it );
+       }
+      }
+      else
+      {
+       result.rTransactionStepList().insert( steps.end(), result.transaction().begin(), result.transaction().end() );
+      }
+      MIL << "Todo: " << result << endl;
+
+      ///////////////////////////////////////////////////////////////////
       // Prepare execution of commit plugins:
       ///////////////////////////////////////////////////////////////////
       CommitPlugins commitPlugins;
@@ -1109,6 +1266,8 @@ namespace zypp
        Pathname plugindir( Pathname::assertprefix( _root, ZConfig::instance().pluginsPath()/"commit" ) );
        commitPlugins.load( plugindir );
       }
+      if ( ! commitPlugins.empty() )
+       commitPlugins.send( transactionPluginFrame( "COMMITBEGIN", steps ) );
 
       ///////////////////////////////////////////////////////////////////
       // Write out a testcase if we're in dist upgrade mode.
@@ -1125,7 +1284,7 @@ namespace zypp
         }
       }
 
-      ///////////////////////////////////////////////////////////////////
+     ///////////////////////////////////////////////////////////////////
       // Store non-package data:
       ///////////////////////////////////////////////////////////////////
       if ( ! policy_r.dryRun() )
@@ -1153,32 +1312,6 @@ namespace zypp
       }
 
       ///////////////////////////////////////////////////////////////////
-      // Compute transaction:
-      ///////////////////////////////////////////////////////////////////
-      ZYppCommitResult result( root() );
-      result.rTransaction() = pool_r.resolver().getTransaction();
-      result.rTransaction().order();
-      // steps: this is our todo-list
-      ZYppCommitResult::TransactionStepList & steps( result.rTransactionStepList() );
-      if ( policy_r.restrictToMedia() )
-      {
-       // Collect until the 1st package from an unwanted media occurs.
-        // Further collection could violate install order.
-       MIL << "Restrict to media number " << policy_r.restrictToMedia() << endl;
-       for_( it, result.transaction().begin(), result.transaction().end() )
-       {
-         if ( makeResObject( *it )->mediaNr() > 1 )
-           break;
-         steps.push_back( *it );
-       }
-      }
-      else
-      {
-       result.rTransactionStepList().insert( steps.end(), result.transaction().begin(), result.transaction().end() );
-      }
-      MIL << "Todo: " << result << endl;
-
-      ///////////////////////////////////////////////////////////////////
       // First collect and display all messages
       // associated with patches to be installed.
       ///////////////////////////////////////////////////////////////////
@@ -1317,6 +1450,12 @@ namespace zypp
       }
 
       ///////////////////////////////////////////////////////////////////
+      // Send result to commit plugins:
+      ///////////////////////////////////////////////////////////////////
+      if ( ! commitPlugins.empty() )
+       commitPlugins.send( transactionPluginFrame( "COMMITEND", steps ) );
+
+      ///////////////////////////////////////////////////////////////////
       // Try to rebuild solv file while rpm database is still in cache
       ///////////////////////////////////////////////////////////////////
       if ( ! policy_r.dryRun() )