Current File : //usr/lib/python2.7/site-packages/salt/modules/snapper.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z y d d l m
Z
e Z Wn e
k
r� e Z n Xd d l m Z d d l Z d d l m Z y d d l Z e Z Wn e
k
r� e Z n Xi d d 6d d
6d d 6d
d 6d d 6d d 6d d 6d d 6d d 6Z d Z d Z d Z e j e � Z d Z d Z d Z! d Z" e ry e j# � Z Wn) e j$ k
r�Z% e j& e% � e% Z qXe e j' � k ry% e j( e j) e e � d e �Z! Wqe j$ e* f k
r
Z% e j& e% � e% Z" qXqd Z" n d � Z+ d � Z, d � Z- d d! � Z. d d d" � Z/ d# � Z0 d$ � Z1 d d% � Z2 d d& � Z3 d' � Z4 d d( � Z5 d d d d d d) � Z6 d d* d d d+ d d, � Z7 d d d- � Z8 d d d d d d. � Z9 d/ � Z: d0 � Z; d1 � Z< d d d d2 � Z= d d d d3 � Z> d d d d d4 � Z? d d5 � Z@ d d6 � ZA d d d d d7 � ZB d d8 � ZC d9 d d: � ZD d S(; uj
Module to manage filesystem snapshots with snapper
.. versionadded:: 2016.11.0
:codeauthor: Duncan Mac-Vicar P. <dmacvicar@suse.de>
:codeauthor: Pablo Suárez Hernández <psuarezhernandez@suse.de>
:depends: ``dbus`` Python module.
:depends: ``snapper`` http://snapper.io, available in most distros
:maturity: new
:platform: Linux
i ( t absolute_importt unicode_literalst print_functionN( t getpwuid( t CommandExecutionError( t sixu createdi u deletedi u type changedi u modifiedi u permission changedi u
owner changedi u
group changedi@ u extended attributes changedi� u ACL info changedi u org.opensuse.Snapperu /org/opensuse/Snappert dbus_interfaceu snapper is missingc C@ sn d } t s t | j d � f St s8 t | j t � f St sQ t | j t � f St sj t | j d � f Sd S( Nu( The snapper module cannot be loaded: {0}u missing python dbus moduleu pwd module not availableu snapper( t HAS_DBUSt Falset formatt snappert
snapper_errort bust system_bus_errort HAS_PWD( t error_msg( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt __virtual__U s c C@ s� i } | d | d <d d d g | d | d <| d d k rP | d | d <n | d d
k rq | d | d <n t t j � � | d <t | d � d | d
<| d | d <| d | d <i | d <x, | d j � D] \ } } | | d | <q� W| S( u�
Returns snapshot data from a D-Bus response.
A snapshot D-Bus response is a dbus.Struct containing the
information related to a snapshot:
[id, type, pre_snapshot, timestamp, user, description,
cleanup_algorithm, userdata]
id: dbus.UInt32
type: dbus.UInt16
pre_snapshot: dbus.UInt32
timestamp: dbus.Int64
user: dbus.UInt32
description: dbus.String
cleaup_algorithm: dbus.String
userdata: dbus.Dictionary
i u idu singleu preu posti u typei i i����u timestampi u useri u descriptioni u cleanupu userdatai ( t intt timeR t items( t snapshott datat keyt value( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt _snapshot_to_datac s
c C@ sG | j � } | d k r) d j | d � S| d k r9 d S| j � Sd S( u>
Returns a error message from a snapper DBusException
u error.unknown_configu Unknown configuration '{0}'u configu error.illegal_snapshotu Invalid snapshotN( t
get_dbus_nameR ( t exct argst error( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt _dbus_exception_to_reason� s u rootc C@ sn y0 t j | � } g | D] } t | � ^ q SWn7 t j k
ri } t d j t | t � � � � � n Xd S( u�
List available snapshots
CLI example:
.. code-block:: bash
salt '*' snapper.list_snapshots config=myconfig
u. Error encountered while listing snapshots: {0}N( R
t
ListSnapshotsR t dbust
DBusExceptionR R R t locals( t configt snapshotst sR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt list_snapshots� s
!c C@ sd y& t j | t | � � } t | � SWn7 t j k
r_ } t d j t | t � � � � � n Xd S( u�
Get detailed information about a given snapshot
CLI example:
.. code-block:: bash
salt '*' snapper.get_snapshot 1
u0 Error encountered while retrieving snapshot: {0}N(
R
t GetSnapshotR R R R R R R R! ( t numberR" R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt get_snapshot� s
c C@ sb y$ t j � } t d � | D� � SWn7 t j k
r] } t d j t | t � � � � � n Xd S( uw
List all available configs
CLI example:
.. code-block:: bash
salt '*' snapper.list_configs
c s@ s# | ] } | d | d f Vq d S( i i N( ( t .0R" ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pys <genexpr>� s u3 Error encountered while listing configurations: {0}N( R
t ListConfigst dictR R R R R R! ( t configsR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt list_configs� s
c C@ s! t | t � r | r d Sd S| S( Nu yesu no( t
isinstancet bool( R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt _config_filter� s c K@ sq y0 t d � | j � D� � } t j | | � Wn: t j k
rl } t d j | t | t � � � � � n Xt
S( uN
Set configuration values
CLI example:
.. code-block:: bash
salt '*' snapper.set_config SYNC_ACL=True
Keys are case insensitive as they will be always uppercased to snapper
convention. The above example is equivalent to:
.. code-block:: bash
salt '*' snapper.set_config sync_acl=True
c s@ s< | ]2 \ } } | j d � s | j � t | � f Vq d S( u __N( t
startswitht upperR0 ( R) t kt v( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pys <genexpr>� s u6 Error encountered while setting configuration {0}: {1}( R+ R R
t SetConfigR R R R R R! t True( t namet kwargsR R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt
set_config� s c C@ s# t t | � d d � �} | d S( u4
Returns the last existing created snapshot
R c S@ s | d S( Nu id( ( t x( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt <lambda>� s i����( t sortedR% ( R" t
snapshot_list( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt _get_last_snapshot� s c
C@ sf | d @| d @| d @| d @| d @| d @| d @| d @| d @f } g | D] } | rL t | ^ qL S(
u�
Converts a numeric dbus snapper status into a string
CLI Example:
.. code-block:: bash
salt '*' snapper.status_to_string <dbus_status>
i i i i i i i@ i� i ( t DBUS_STATUS_MAP( t dbus_statust status_tuplet status( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt status_to_string s c C@ sU y t j | � } | SWn7 t j k
rP } t d j t | t � � � � � n Xd S( u�
Retrieves all values from a given configuration
CLI example:
.. code-block:: bash
salt '*' snapper.get_config
u5 Error encountered while retrieving configuration: {0}N( R
t GetConfigR R R R R R! ( R7 R" R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt
get_config s
c C@ s� d � } | s | d � n | s/ | d � n | sB | d � n | sQ d } n y: t j | | | | � | r� t | | � n t | � SWn7 t j k
r� } t d j t | t � � � � � n Xd S( u
Creates a new Snapper configuration
name
Name of the new Snapper configuration.
subvolume
Path to the related subvolume.
fstype
Filesystem type of the subvolume.
template
Configuration template to use. (Default: default)
extra_opts
Extra Snapper configuration opts dictionary. It will override the values provided
by the given template (if any).
CLI example:
.. code-block:: bash
salt '*' snapper.create_config name=myconfig subvolume=/foo/bar/ fstype=btrfs
salt '*' snapper.create_config name=myconfig subvolume=/foo/bar/ fstype=btrfs template="default"
salt '*' snapper.create_config name=myconfig subvolume=/foo/bar/ fstype=btrfs extra_opts='{"NUMBER_CLEANUP": False}'
c S@ s t d j | � � � d S( Nu2 You must provide a "{0}" for the new configuration( R R ( t argname( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt raise_arg_errorD s u nameu subvolumeu fstypeu u; Error encountered while creating the new configuration: {0}N(
R
t CreateConfigR9 RE R R R R R R! ( R7 t subvolumet fstypet templatet
extra_optsRG R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt
create_config( s$
u singleu numberc
K@ sQ | s i } n | j d � } | d
k rH | d
k rH d j | � } n | d
k ra | | d <n d
} y� | d k r� t j | | | | � } n� | d k r� t j | | | | � } nZ | d k r� | d
k r� t d � � n t j | | | | | � } n t d j | � � � Wn7 t j k
rL} t d j t
| t � � � � � n X| S( u�
Creates an snapshot
config
Configuration name.
snapshot_type
Specifies the type of the new snapshot. Possible values are
single, pre and post.
pre_number
For post snapshots the number of the pre snapshot must be
provided.
description
Description for the snapshot. If not given, the salt job will be used.
cleanup_algorithm
Set the cleanup algorithm for the snapshot.
number
Deletes old snapshots when a certain number of snapshots
is reached.
timeline
Deletes old snapshots but keeps a number of hourly,
daily, weekly, monthly and yearly snapshots.
empty-pre-post
Deletes pre/post snapshot pairs with empty diffs.
userdata
Set userdata for the snapshot (key-value pairs).
Returns the number of the created snapshot.
CLI example:
.. code-block:: bash
salt '*' snapper.create_snapshot
u __pub_jidu salt job {0}u salt_jidu singleu preu postuV pre snapshot number 'pre_number' needs to bespecified for snapshots of the 'post' typeu Invalid snapshot type '{0}'u2 Error encountered while listing changed files: {0}N( t gett NoneR R
t CreateSingleSnapshott CreatePreSnapshotR t CreatePostSnapshotR R R R! (
R" t
snapshot_typet
pre_numbert descriptiont cleanup_algorithmt userdataR8 t jidt new_nrR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt create_snapshot^ s8 &
c C@ s" | s t d � � n y� g t | � D] } | d ^ q% } t | t � sV | g } n t | � j t | � � s� t d j d j g t | � j t | � � D] } t j
| � ^ q� � � � � n t j | | � i i | d 6d d 6| 6SWn. t
j k
r } t t | t � � � � n Xd S( ux
Deletes an snapshot
config
Configuration name. (Default: root)
snapshots_ids
List of the snapshots IDs to be deleted.
CLI example:
.. code-block:: bash
salt '*' snapper.delete_snapshot 54
salt '*' snapper.delete_snapshot config=root 54
salt '*' snapper.delete_snapshot config=root snapshots_ids=[54,55,56]
u' Error: No snapshot ID has been providedu idu Error: Snapshots '{0}' not foundu , u idsu deletedu statusN( R R% R. t listt sett issubsetR t joint
differenceR t text_typeR
t DeleteSnapshotsR R R R! ( t
snapshots_idsR" R: t current_snapshots_idsR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt delete_snapshot� s # 4 c C@ s� | s t d � � n t d | d | � } y� i | d k rB | n | d d 6| d k r_ | n | d d 6| d k r| | n | d d 6} t j | | | d | d | d � t d | d | � SWn. t j k
r� } t t | t � � � � n Xd S( u�
Modify attributes of an existing snapshot.
config
Configuration name. (Default: root)
snapshot_id
ID of the snapshot to be modified.
cleanup
Change the cleanup method of the snapshot. (str)
description
Change the description of the snapshot. (str)
userdata
Change the userdata dictionary of the snapshot. (dict)
CLI example:
.. code-block:: bash
salt '*' snapper.modify_snapshot 54 description="my snapshot description"
salt '*' snapper.modify_snapshot 54 description="my snapshot description"
salt '*' snapper.modify_snapshot 54 userdata='{"foo": "bar"}'
salt '*' snapper.modify_snapshot snapshot_id=54 cleanup="number"
u' Error: No snapshot ID has been providedR" R' u descriptionu cleanupu userdataN( R R( RO R
t SetSnapshotR R R R! ( t snapshot_idRU RW t cleanupR" R t updated_optsR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt modify_snapshot� s c C@ sJ | r t | � n d } | d k r0 t | � n
t | � d } | | f S( uP
Returns numerical interval based on optionals num_pre, num_post values
i u idN( R RO R> ( R" t num_pret num_postt postt pre( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt _get_num_interval s (c C@ s. t j d j | � d � j � } | j d � S( u)
Checks if a file is a text file
u file -bi {0}u ru text( t ost popenR t readR1 ( t filenamet type_of_file( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt
_is_text_file
s !c O@ sc | j d d � } | j d d j | � � } | j d d � } | j d i � } t d � | j � D� � } t d � | j � D� � } t d
d | d d
d | d | d | | � } | t k r� t d j | � � � n y t | | | � } Wn8 t k
r,}
d j t j |
� t | j g � } n Xt d
d | d d d | d | d | d | | � | S( u
Runs a function from an execution module creating pre and post snapshots
and associating the salt job id with those snapshots for easy undo and
cleanup.
function
Salt function to call.
config
Configuration name. (default: "root")
description
A description for the snapshots. (default: None)
userdata
Data to include in the snapshot metadata. (default: None)
cleanup_algorithm
Snapper cleanup algorithm. (default: "number")
`*args`
args for the function to call. (default: None)
`**kwargs`
kwargs for the function to call (default: None)
This would run append text to /etc/motd using the file.append
module, and will create two snapshots, pre and post with the associated
metadata. The jid will be available as salt_jid in the userdata of the
snapshot.
You can immediately see the changes
CLI Example:
.. code-block:: bash
salt '*' snapper.run file.append args='["/etc/motd", "some text"]'
u configu rootu descriptionu snapper.run[{0}]u cleanup_algorithmu numberu userdatac s@ s0 | ]& \ } } | j d � s | | f Vq d S( u __N( R1 ( R) R3 R4 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pys <genexpr>? s c s@ s0 | ]& \ } } | j d � r | | f Vq d S( u __N( R1 ( R) R3 R4 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pys <genexpr>@ s u snapper.create_snapshotR" RS u preRU RV RW u function "{0}" does not existu
u postRT (
t popR R+ R t __salt__R R^ R R` t __doc__( t functionR R8 R" RU RV RW t func_kwargst pre_nrt retR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt run s: (
)
c C@ s" y� t | | | � \ } } t j | t | � t | � � t j | t | � t | � � } i } t � | d } xj | D]b } | d j | � r� | d t | � n | d } i t | d � d 6| t j
j | | � <qy W| SWn7 t j
k
r }
t d j t |
t � � � � � n Xd S( u|
Returns a comparison between two snapshots
config
Configuration name.
num_pre
first snapshot ID to compare. Default is last snapshot
num_post
last snapshot ID to compare. Default is 0 (current state)
CLI example:
.. code-block:: bash
salt '*' snapper.status
salt '*' snapper.status num_pre=19 num_post=20
u SUBVOLUMEi i u statusu2 Error encountered while listing changed files: {0}N( Rn R
t CreateComparisonR t GetFilesR- R1 t lenRC Ro t patht normpathR R R R R R! ( R" Rj Rk Rm Rl t filest
status_rett SUBVOLUMEt filet _filepathR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyRB _ s !
1/c C@ s t | | | � j � S( u�
Returns the files changed between two snapshots
config
Configuration name.
num_pre
first snapshot ID to compare. Default is last snapshot
num_post
last snapshot ID to compare. Default is 0 (current state)
CLI example:
.. code-block:: bash
salt '*' snapper.changed_files
salt '*' snapper.changed_files num_pre=19 num_post=20
( RB t keys( R" Rj Rk ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt
changed_files� s c C@ s t | | | � \ } } t | | | � } t | j � � } t | pH | � } | j | � sy t d j | | � � � n t d d j | | | d j | � � � } yM | j d � }
i } x- |
D]% } | j d � \ }
} | | |
<q� W| SWn( t
k
r} t d j | � � � n Xd S( u,
Undo all file changes that happened between num_pre and num_post, leaving
the files into the state of num_pre.
.. warning::
If one of the files has changes after num_post, they will be overwritten
The snapshots are used to determine the file list, but the current
version of the files will be overwritten by the versions in num_pre.
You to undo changes between num_pre and the current version of the
files use num_post=0.
CLI Example:
.. code-block:: bash
salt '*' snapper.undo
uO Given file list contains files that are not presentin the changed filelist: {0}u cmd.runu& snapper -c {0} undochange {1}..{2} {3}u u :u, Error while processing Snapper response: {0}N( Rn RB R\ R� R] R R Rv R^ t splitt
ValueError( R" R� Rj Rk Rm Rl t changest changedt requestedt cmdrett
componentsR{ t compR t valR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt undo� s(
c C@ s� g t | � D]% } | d j d � | k r
| ^ q
} g | D] } | d d k r? | ^ q? } g | D] } | d d k rh | ^ qh } | s� | r� t d j | � � � n | d d | d d f S( u�
Returns pre/post snapshots made by a given Salt jid
Looks for 'salt_jid' entries into snapshots userdata which are created
when 'snapper.run' is executed.
u userdatau salt_jidu typeu preu postu Jid '{0}' snapshots not foundi u id( R% RN R R ( RX R" R: t
jid_snapshotst pre_snapshott
post_snapshot( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt _get_jid_snapshots� s 8)) c C@ s. t | d | �\ } } t | d | d | �S( u�
Undo the changes applied by a salt job
jid
The job id to lookup
config
Configuration name.
CLI Example:
.. code-block:: bash
salt '*' snapper.undo_jid jid=20160607130930720112
R" Rj Rk ( R� R� ( RX R" R� R� ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt undo_jid� s c
C@ s y�t | | | � \ } } t | | | � } | rQ | | k rH | g n g } n t � | d } | r} t j | | t � n | } | r� t j | | t � n | } t � }
x�g | D] } t j j | � s� | ^ q� D]�} | } | j
| � r| t | � } n t j j | d | � j
d d � }
t j j | d | � j
d d � } t j j |
� r�t } t j j j |
� �5 } g | j � D] } t j j j | � ^ q�} Wd QXn g } t } t j j | � r-t } t j j j | � �5 } g | j � D] } t j j j | � ^ q} Wd QXn g } t } t |
� sQt | � r�i d d 6d j t j | | d |
d | �� d
6|
| <| r�| r�d |
| d <n | r�| r�d |
| d <q�q� t |
� r� t | � r� i d
d 6|
| <| r t d d j | � � |
| d <n | rHt d d j | � � |
| d <n | rf| rfd |
| d <n | r�| r�d |
| d <q�q� q� W| r�t j | | t � n | r�t j | | t � n |
SWn7 t j k
r} t d j t! | t" � � � � � n Xd S( u
Returns the differences between two snapshots
config
Configuration name.
filename
if not provided the showing differences between snapshots for
all "text" files
num_pre
first snapshot ID to compare. Default is last snapshot
num_post
last snapshot ID to compare. Default is 0 (current state)
CLI Example:
.. code-block:: bash
salt '*' snapper.diff
salt '*' snapper.diff filename=/var/log/snapper.log num_pre=19 num_post=20
u SUBVOLUMEu /u //Nu text file changedu commentu t fromfilet tofileu diffu text file deletedu text file createdu binary file changedu hashutil.sha256_digestu old_sha256_digestu new_sha256_digestu binary file createdu binary file deleteduB Error encountered while showing differences between snapshots: {0}(# Rn R� R- R
t
MountSnapshotR R+ Ro R� t isdirR1 R R� t replacet isfileR6 t saltt utilsR� t fopent readlinest stringutilst
to_unicodeRt R^ t difflibt unified_diffRv t UmountSnapshotR R R R R R! ( R" Rr Rj Rk Rm Rl R� R� t pre_mountt
post_mountt
files_difft filepathR� t pre_filet post_filet pre_file_existst rfht _lt pre_file_contentt post_file_existst post_file_contentR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt diff� sv !! 2&&44
$$
c C@ s. t | d | �\ } } t | d | d | �S( u�
Returns the changes applied by a `jid`
jid
The job id to lookup
config
Configuration name.
CLI Example:
.. code-block:: bash
salt '*' snapper.diff_jid jid=20160607130930720112
R" Rj Rk ( R� R� ( RX R" R� R� ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt diff_jidW s u baselinec
C@ s0 t d d | d d d d d d d i | d
6� S( u
Creates a snapshot marked as baseline
tag
Tag name for the baseline
config
Configuration name.
CLI Example:
.. code-block:: bash
salt '*' snapper.create_baseline
salt '*' snapper.create_baseline my_custom_baseline
u snapper.create_snapshotR" RS u singleRU u baseline snapshotRV u numberRW u baseline_tag( Rv ( t tagR" ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt create_baselinek s
(E Rw t
__future__R R R t loggingRo R R� t pwdR R6 R t ImportErrorR t salt.exceptionsR t salt.utils.filesR� t salt.extR R R R? t SNAPPER_DBUS_OBJECTt SNAPPER_DBUS_PATHt SNAPPER_DBUS_INTERFACEt getLoggert __name__t logRO R R
R
R t SystemBusR R t warningt list_activatable_namest Interfacet
get_objectR� R R R R% R( R- R0 R9 R> RC RE RM RZ Rd Ri Rn Rt R| RB R� R� R� R� R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/snapper.pyt <module> s�
*
2 I$ 1 M'- e
Mini Shell