From 79452f1af0c6caeb8b0e5e15b3d718c8314fb531 Mon Sep 17 00:00:00 2001 From: Tomas Bzatek Date: Fri, 18 Apr 2014 16:12:23 +0200 Subject: New journald script Requires OpenLMI journald provider 0.4.2 (MOF version number) and higher. --- commands/journald/Makefile | 1 + commands/journald/README.md | 3 + commands/journald/doc/Makefile | 201 +++++++++++++++ commands/journald/doc/cmdline.generated | 42 +++ commands/journald/doc/cmdline.rst | 3 + commands/journald/doc/conf.py.skel | 285 +++++++++++++++++++++ commands/journald/doc/index.rst | 19 ++ commands/journald/lmi/__init__.py | 27 ++ commands/journald/lmi/scripts/__init__.py | 27 ++ commands/journald/lmi/scripts/journald/__init__.py | 132 ++++++++++ commands/journald/lmi/scripts/journald/cmd.py | 75 ++++++ commands/journald/setup.cfg | 2 + commands/journald/setup.py.skel | 44 ++++ 13 files changed, 861 insertions(+) create mode 100644 commands/journald/Makefile create mode 100644 commands/journald/README.md create mode 100644 commands/journald/doc/Makefile create mode 100644 commands/journald/doc/cmdline.generated create mode 100644 commands/journald/doc/cmdline.rst create mode 100644 commands/journald/doc/conf.py.skel create mode 100644 commands/journald/doc/index.rst create mode 100644 commands/journald/lmi/__init__.py create mode 100644 commands/journald/lmi/scripts/__init__.py create mode 100644 commands/journald/lmi/scripts/journald/__init__.py create mode 100644 commands/journald/lmi/scripts/journald/cmd.py create mode 100644 commands/journald/setup.cfg create mode 100644 commands/journald/setup.py.skel diff --git a/commands/journald/Makefile b/commands/journald/Makefile new file mode 100644 index 0000000..91e14dc --- /dev/null +++ b/commands/journald/Makefile @@ -0,0 +1 @@ +include ../../Makefile.inc \ No newline at end of file diff --git a/commands/journald/README.md b/commands/journald/README.md new file mode 100644 index 0000000..1f7adb7 --- /dev/null +++ b/commands/journald/README.md @@ -0,0 +1,3 @@ +Journal message log management through OpenLMI journald providers. + +This command allows to list and traverse through system journal and logging new messages. diff --git a/commands/journald/doc/Makefile b/commands/journald/doc/Makefile new file mode 100644 index 0000000..db887d2 --- /dev/null +++ b/commands/journald/doc/Makefile @@ -0,0 +1,201 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build +COMMAND_NAME := journald + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext cmdregen cmdline.generated + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " " + @echo " cmdregen to regenerate cmdline.generated with actual content from installed lmi help" + +cmdregen: cmdline.generated + +cmdline.generated: + if ! python -c 'import lmi.scripts.$(COMMAND_NAME)' >/dev/null; then \ + echo "Please install install the command library first." >&2; \ + exit 1; \ + fi + ( \ + echo ".."; \ + echo " !!!!!!!!!"; \ + echo -n " This is generated file. Use 'make cmdregen' to regenerate it"; \ + echo " from installed 'lmi help '"; \ + echo " !!!!!!!!!"; \ + echo ; \ + for i in `sed -n '/entry_points/,/)/p' ../setup.py | \ + sed -n "s/\s*,\?['\"]\s*\([a-z-]\+\)\s*=.*/\1/p"`; do \ + lmi help $$i | python ../../../tools/help2rst $$i | \ + tr -d '\033' |sed 's/..1034h//'; \ + done \ + ) > $@ + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLMIJournaldscripts.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLMIJournaldscripts.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLMIJournaldscripts" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLMIJournaldscripts" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/commands/journald/doc/cmdline.generated b/commands/journald/doc/cmdline.generated new file mode 100644 index 0000000..ea06477 --- /dev/null +++ b/commands/journald/doc/cmdline.generated @@ -0,0 +1,42 @@ +.. + !!!!!!!!! + This is generated file. Use 'make cmdregen' to regenerate it from installed 'lmi help ' + !!!!!!!!! + +journald +-------- + +Journald message log management. + + +**Usage:** + + **lmi** **journald** **list** [(\ **--reverse**\ | \ **--tail**\ )] + + **lmi** **journald** **logger** \ **\ + + **lmi** **journald** watch + + + +**Commands:** + + + **list** + Lists messages logged in the journal + + **logger** + Logs a new message in the journal + + **watch** + Watch for newly logged messages + +**Options:** + + + **--reverse** + List messages from newest to oldest + + **--tail** + List only the last 50 messages + diff --git a/commands/journald/doc/cmdline.rst b/commands/journald/doc/cmdline.rst new file mode 100644 index 0000000..903fa22 --- /dev/null +++ b/commands/journald/doc/cmdline.rst @@ -0,0 +1,3 @@ +LMI command line reference +========================== +.. include:: cmdline.generated diff --git a/commands/journald/doc/conf.py.skel b/commands/journald/doc/conf.py.skel new file mode 100644 index 0000000..867e629 --- /dev/null +++ b/commands/journald/doc/conf.py.skel @@ -0,0 +1,285 @@ +# -*- coding: utf-8 -*- +# +# journald documentation build configuration file, created by +# sphinx-quickstart on Wed Apr 2 10:04:55 2014. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'journald' +copyright = u'2014, Tomas Bzatek' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '@@VERSION@@' +# The full version, including alpha/beta/rc tags. +release = '@@VERSION@@' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'journalddoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'journald.tex', u'journald Documentation', + u'Tomas Bzatek', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'journald', u'journald Documentation', + [u'Tomas Bzatek'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'journald', u'journald Documentation', + u'Tomas Bzatek', 'journald', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'journald' +epub_author = u'Tomas Bzatek' +epub_publisher = u'Tomas Bzatek' +epub_copyright = u'2014, Tomas Bzatek' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/commands/journald/doc/index.rst b/commands/journald/doc/index.rst new file mode 100644 index 0000000..5b1e584 --- /dev/null +++ b/commands/journald/doc/index.rst @@ -0,0 +1,19 @@ +OpenLMI Journald Scripts documentation +========================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + cmdline + python + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/commands/journald/lmi/__init__.py b/commands/journald/lmi/__init__.py new file mode 100644 index 0000000..b1a2ff0 --- /dev/null +++ b/commands/journald/lmi/__init__.py @@ -0,0 +1,27 @@ +# Copyright (C) 2013-2014 Red Hat, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# The views and conclusions contained in the software and documentation are +# those of the authors and should not be interpreted as representing official +# policies, either expressed or implied, of the FreeBSD Project. +__import__('pkg_resources').declare_namespace(__name__) diff --git a/commands/journald/lmi/scripts/__init__.py b/commands/journald/lmi/scripts/__init__.py new file mode 100644 index 0000000..b1a2ff0 --- /dev/null +++ b/commands/journald/lmi/scripts/__init__.py @@ -0,0 +1,27 @@ +# Copyright (C) 2013-2014 Red Hat, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# The views and conclusions contained in the software and documentation are +# those of the authors and should not be interpreted as representing official +# policies, either expressed or implied, of the FreeBSD Project. +__import__('pkg_resources').declare_namespace(__name__) diff --git a/commands/journald/lmi/scripts/journald/__init__.py b/commands/journald/lmi/scripts/journald/__init__.py new file mode 100644 index 0000000..d385141 --- /dev/null +++ b/commands/journald/lmi/scripts/journald/__init__.py @@ -0,0 +1,132 @@ +# Copyright (C) 2014 Red Hat, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# The views and conclusions contained in the software and documentation are +# those of the authors and should not be interpreted as representing official +# policies, either expressed or implied, of the FreeBSD Project. + +from lmi.scripts.common.errors import LmiFailed +from lmi.shell import LMIIndicationListener +import socket +import time +import random + +NUM_TAIL = 50 + +def list_messages(ns, reverse=False, tail=False): + """ + List messages from the journal. + + :param boolean reverse: List messages from newest to oldest. + :param boolean tail: List only the last 50 messages + """ + + inst = ns.LMI_JournalMessageLog.first_instance() + if not inst: + raise LmiFailed("Cannot initialize Journald provider. (hint: check if it's installed)") + + if reverse or tail: + r = inst.PositionToLastRecord() + else: + r = inst.PositionToFirstRecord() + if not 'IterationIdentifier' in r.rparams: + raise LmiFailed("Cannot initialize Journald iteration. (hint: check SELinux AVCs)") + iter_id = r.rparams['IterationIdentifier'] + + if tail: + r = inst.PositionAtRecord(IterationIdentifier=iter_id, MoveAbsolute=False, RecordNumber=-NUM_TAIL) + iter_id = r.rparams['IterationIdentifier'] + + try: + while True: + r = inst.GetRecord(IterationIdentifier=iter_id, PositionToNext=(not reverse)) + if r.rval != 0: + break + iter_id = r.rparams['IterationIdentifier'] + + if reverse: + x = inst.PositionAtRecord(IterationIdentifier=iter_id, MoveAbsolute=False, RecordNumber=-1) + iter_id = x.rparams['IterationIdentifier'] + + print "".join(map(chr, r.rparams['RecordData'])) + except KeyboardInterrupt: + pass + + inst.CancelIteration(IterationIdentifier=iter_id) + + return 0; + + +def log_message(ns, message): + """ + Logs a new message in the journal. + + :param message: A message to log. + :type message: string + """ + ns.LMI_JournalLogRecord.create_instance({"CreationClassName": "LMI_JournalLogRecord", + "LogCreationClassName": "LMI_JournalMessageLog", + "LogName": "Journal", + "DataFormat": message}) + + return 0; + + +def ind_handler(indication, **kwargs): + exported_objects = indication.exported_objects() + for i in exported_objects: + print i["SourceInstance"]["DataFormat"] + +def watch(ns): + """ + Sets up a new indication listener and waits for events. + """ + + indication_port = random.randint(12000, 13000) + listener = LMIIndicationListener("0.0.0.0", indication_port) + uniquename = listener.add_handler("lmiscript_journald_watch-XXXXXXXX", ind_handler) + ret = listener.start() + if not ret: + raise LmiFailed("Cannot initialize indication listener on port %d" % indication_port) + + ret = ns.connection.subscribe_indication( + Name=uniquename, + Query="SELECT * FROM LMI_JournalLogRecordInstanceCreationIndication WHERE SOURCEINSTANCE ISA LMI_JournalLogRecord", + Destination="http://%s:%d" % (socket.gethostname(), indication_port) + ) + if not ret or not ret.rval: + raise LmiFailed("Failed to register indication: %s\n" % retval.errorstr) + + try: + print "Watching journal, press Ctrl+C to abort" + print "" + while True: + time.sleep(1) + pass + + except KeyboardInterrupt: + pass + + ns.connection.unsubscribe_indication(uniquename) + + return 0; diff --git a/commands/journald/lmi/scripts/journald/cmd.py b/commands/journald/lmi/scripts/journald/cmd.py new file mode 100644 index 0000000..b6686c6 --- /dev/null +++ b/commands/journald/lmi/scripts/journald/cmd.py @@ -0,0 +1,75 @@ +# Copyright (C) 2014 Red Hat, Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# +# The views and conclusions contained in the software and documentation are +# those of the authors and should not be interpreted as representing official +# policies, either expressed or implied, of the FreeBSD Project. +# +# Authors: Tomas Bzatek +# +""" +Journald message log management. + +Usage: + %(cmd)s list [(--reverse | --tail)] + %(cmd)s logger + %(cmd)s watch + +Commands: + list Lists messages logged in the journal + logger Logs a new message in the journal + watch Watch for newly logged messages + +Options: + --reverse List messages from newest to oldest + --tail List only the last 50 messages +""" +import functools + +from lmi.scripts import journald as journ +from lmi.scripts.common import command + +class Lister(command.LmiCheckResult): + CALLABLE = journ.list_messages + EXPECT = 0 + + def transform_options(self, options): + options['reverse'] = options.pop('--reverse') + options['tail'] = options.pop('--tail') + +class Logger(command.LmiCheckResult): + CALLABLE = journ.log_message + EXPECT = 0 + +class Watcher(command.LmiCheckResult): + CALLABLE = journ.watch + EXPECT = 0 + + +Journald = command.register_subcommands( + 'Journald', __doc__, + { 'list' : Lister + , 'logger' : Logger + , 'watch' : Watcher + }, + ) diff --git a/commands/journald/setup.cfg b/commands/journald/setup.cfg new file mode 100644 index 0000000..2ddce25 --- /dev/null +++ b/commands/journald/setup.cfg @@ -0,0 +1,2 @@ +[upload_docs] +upload-dir = doc/_build/html diff --git a/commands/journald/setup.py.skel b/commands/journald/setup.py.skel new file mode 100644 index 0000000..8d20faa --- /dev/null +++ b/commands/journald/setup.py.skel @@ -0,0 +1,44 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from setuptools import setup + +try: + long_description = open('README.md', 'rt').read() +except IOError: + long_description = '' + +setup( + name='openlmi-scripts-journald', + version='@@VERSION@@', + description='journald', + long_description=long_description, + author=u'Tomas Bzatek', + author_email='tbzatek@redhat.com', + url='https://github.com/openlmi/openlmi-scripts', + download_url='https://github.com/openlmi/openlmi-scripts/tarball/master', + platforms=['Any'], + license="BSD", + classifiers=[ + 'License :: OSI Approved :: BSD License', + 'Operating System :: POSIX :: Linux', + 'Topic :: System :: Systems Administration', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.7', + 'Intended Audience :: Developers', + 'Environment :: Console', + ], + + install_requires=['openlmi-scripts'], + + namespace_packages=['lmi', 'lmi.scripts'], + packages=['lmi', 'lmi.scripts', 'lmi.scripts.journald'], + include_package_data=True, + + entry_points={ + 'lmi.scripts.cmd': [ + 'journald = lmi.scripts.journald.cmd:Journald', + ], + }, + ) -- cgit From 23fe1d0158b47365b1c7f46a337565c04cd3fee3 Mon Sep 17 00:00:00 2001 From: Tomas Bzatek Date: Wed, 23 Apr 2014 17:05:41 +0200 Subject: journald: Fix authorship --- commands/journald/lmi/scripts/journald/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/commands/journald/lmi/scripts/journald/__init__.py b/commands/journald/lmi/scripts/journald/__init__.py index d385141..6863f74 100644 --- a/commands/journald/lmi/scripts/journald/__init__.py +++ b/commands/journald/lmi/scripts/journald/__init__.py @@ -24,6 +24,9 @@ # The views and conclusions contained in the software and documentation are # those of the authors and should not be interpreted as representing official # policies, either expressed or implied, of the FreeBSD Project. +# +# Authors: Tomas Bzatek +# from lmi.scripts.common.errors import LmiFailed from lmi.shell import LMIIndicationListener -- cgit From 1d77ea81bd7773f94da98a15cc182eba8fac699e Mon Sep 17 00:00:00 2001 From: Tomas Bzatek Date: Wed, 23 Apr 2014 17:06:07 +0200 Subject: journald: Add provider version requirement test The journald script makes use of newly added LMI_JournalMessageLog. PositionToLastRecord() method, let's add explicit version check. --- commands/journald/lmi/scripts/journald/cmd.py | 11 +++++++++++ commands/journald/setup.py.skel | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/commands/journald/lmi/scripts/journald/cmd.py b/commands/journald/lmi/scripts/journald/cmd.py index b6686c6..5d3bcb6 100644 --- a/commands/journald/lmi/scripts/journald/cmd.py +++ b/commands/journald/lmi/scripts/journald/cmd.py @@ -48,6 +48,7 @@ import functools from lmi.scripts import journald as journ from lmi.scripts.common import command +from lmi.scripts.common.command import LmiSelectCommand class Lister(command.LmiCheckResult): CALLABLE = journ.list_messages @@ -73,3 +74,13 @@ Journald = command.register_subcommands( , 'watch' : Watcher }, ) + +class JournaldCMD(LmiSelectCommand): + """ + Test for provider version requirements + """ + SELECT = [ + ( 'OpenLMI-Journald >= 0.4.2', + # command already defined with register_subcommands() + Journald ) + ] diff --git a/commands/journald/setup.py.skel b/commands/journald/setup.py.skel index 8d20faa..08cb4a2 100644 --- a/commands/journald/setup.py.skel +++ b/commands/journald/setup.py.skel @@ -38,7 +38,7 @@ setup( entry_points={ 'lmi.scripts.cmd': [ - 'journald = lmi.scripts.journald.cmd:Journald', + 'journald = lmi.scripts.journald.cmd:JournaldCMD', ], }, ) -- cgit