sdputils.py #2

  • //
  • guest/
  • perforce_software/
  • sdp/
  • dev/
  • Unsupported/
  • Maintenance/
  • sdputils.py
  • View
  • Commits
  • Open Download .zip Download (1 KB)
#!/usr/bin/env python

"""
This module is a convenience for other modules in this directory
"""

# Python 2.7/3.3 compatibility.
from __future__ import print_function

import os
import sys
import platform

class SDPUtils:
  def __init__(self, sdp_instance):
    self.sdp_instance = sdp_instance

    # Python 2.7/3.3 compatibility.
    if sys.version_info[0] >= 3:
      import configparser
      self.rawconfig = configparser.RawConfigParser()
    else:
      import ConfigParser
      self.rawconfig = ConfigParser.RawConfigParser()

    ##########################################################################
    #####                                #####
    #####  CONFIGURATION VARIABLES: Modify in maintenance.cfg as needed. #####
    #####                                #####
    self.rawconfig.read('maintenance.cfg')
    self.server = os.environ.get('P4PORT')
    self.p4user = os.environ.get('P4USER')

    if platform.system() == "Windows":
      self.p4 = "p4.exe -p %s -u %s" % (self.server, self.p4user)
    else:
      self.p4 = "/p4/%s/bin/p4_%s -u %s -p %s" % (self.sdp_instance, self.sdp_instance, self.p4user, self.server)
      self.p4_noport = "/p4/%s/bin/p4_%s -u %s" % (self.sdp_instance, self.sdp_instance, self.p4user)

  def get(self, varname):
    return self.rawconfig.get(self.sdp_instance, varname)

  def login(self):
    os.system('%s -p %s login -a < /p4/common/config/.p4passwd.p4_%s.admin' % (self.p4_noport, self.server, self.sdp_instance))

# Change User Description Committed
#2 27722 C. Thomas Tyler Refinements to @27712:
* Resolved one out-of-date file (verify_sdp.sh).
* Added missing adoc file for which HTML file had a change (WorkflowEnforcementTriggers.adoc).
* Updated revdate/revnumber in *.adoc files.
* Additional content updates in Server/Unix/p4/common/etc/cron.d/ReadMe.md.
* Bumped version numbers on scripts with Version= def'n.
* Generated HTML, PDF, and doc/gen files:
  - Most HTML and all PDF are generated using Makefiles that call an AsciiDoc utility.
  - HTML for Perl scripts is generated with pod2html.
  - doc/gen/*.man.txt files are generated with .../tools/gen_script_man_pages.sh.

#review-27712
#1 26652 Robert Cowham This is Tom's change:

Introduced new 'Unsupported' directory to clarify that some files
in the SDP are not officially supported. These files are samples for
illustration, to provide examples, or are deprecated but not yet
ready for removal from the package.

The Maintenance and many SDP triggers have been moved under here,
along with other SDP scripts and triggers.

Added comments to p4_vars indicating that it should not be edited
directly. Added reference to an optional site_global_vars file that,
if it exists, will be sourced to provide global user settings
without needing to edit p4_vars.

As an exception to the refactoring, the totalusers.py Maintenance
script will be moved to indicate that it is supported.

Removed settings to support long-sunset P4Web from supported structure.

Structure under new .../Unsupported folder is:
   Samples/bin             Sample scripts.
   Samples/triggers        Sample trigger scripts.
   Samples/triggers/tests  Sample trigger script tests.
   Samples/broker          Sample broker filter scripts.
   Deprecated/triggers     Deprecated triggers.

To Do in a subsequent change: Make corresponding doc changes.
//guest/perforce_software/sdp/dev/Maintenance/sdputils.py
#4 26237 C. Thomas Tyler Fixed to get default SDP_INSTANCE if no parameter given.

Also fixed spurious extra chars (copy/paste error?) in
sdputil.py.

#review @matt_peterson
#3 26060 C. Thomas Tyler This supercedes review-24715.

Bringing over recent bug fixes and code clean up from Rusty Jackson's local branch.

Adds an edge maintenance script to unload clients on edge servers.

Automated setting up maintenance.cfg from mkdirs.cfg settings.

Cleaned up sdputils.py - It had a logic bug, and fixed all scripts based on changes.

== Merge Details ==

Merge strategy: All the fixes to Maintenance scripts were brought in, but not the changes to active them in crontab that would enable them.

Rusty's original change had crontab changes to call maintenance scripts, and also calls to 'p4 unlock -x' as a workround to p4d bugs related to orphanged locks on edge servers. Those bugs are already fixed.  Also, adding anything new to cron requires a test suite addition and doc updates.  So changes to the template.crontab.combined were ignored. However, a new file was added to the Maintenace folder, sample_cron_entries.txt, to make it easy for folks to see those changes.

Rusty's original change had mkdirs.sh changes to generate maintenance.cfg. This change was enhanced during the merge. Rather than overwriting maintenance.cfg (potentially blowing away configuration for other instances), a new section for the new instance is appended to maintenance.cfg when 'mkdirs.sh <instance>' is run.

Future considerations: Before adding anything from Maintenance to cron, we  need to do the following:
* Have mkdirs.sh install the Maintenance folder to the as-deployed structure under /p4/common, i.e. to /p4/common/maintenance, for HMS management compliance.
* Add tests and docs for each script called (directly or indirectly).
#2 22337 Russell C. Jackson (Rusty) Added +x to file types.
#1 16638 C. Thomas Tyler Routine merge down to dev from main using:
p4 merge -b perforce_software-sdp-dev
//guest/perforce_software/sdp/main/Maintenance/sdputils.py
#1 16581 Robert Cowham Standardised processing and formatting.
Made python 2/3 compatible.
These need automated testing!