xref: /smf-profiles/gate

Welcome to the Enhanced SMF Profiles project.

To use it:
  You can boot a zone with it, but it's missing things like permission
  checking and service & instance deletion.  See below for how to install it
  in a zone.

To contribute code:
  - Clone the gate with something like

  hg clone ssh://anon (a] hg.opensolaris.org//hg/smf-profiles/gate profiles-wip

    Inside SWAN, building will be easier with the closed tree, which you
    can get with

  cd profiles-wip/usr
  hg clone ssh://anonhg (a] onnv.sfbay//export/onnv-clone/usr/closed closed

  - I don't like building the entire gate, so I just build what's necessary to
    test the parts we've changed.  The "build_profiles" script in the root
    does this.  The script runs make and uses $SRC, so it's easiest to run it
    from a ws shell.

    If you're compiling on a small machine (like a laptop), export
    CW_NO_SHADOW=1 in the environment to avoid gcc shadow compilation.  If
    you don't have access to /ws/onnv-tools, export BUILD_TOOLS set to where
    your SUNWspro and onbld directories are, such as /opt.

  - With libscf and svc.configd built & installed in the proto area, you
    can run the ex-situ test suite for them, in $SRC/lib/libscf/test.
    Build the tests with "make", and run them with "./dotests".  Run
    individual tests with "./dotests <test names>".

    If svc.configd consistently fails a libscf test, you can debug it by
    attaching mdb to it while running the test.  Start svc.configd with

	$SRC/common/svc/test/configdctl start $SRC/cmd/svc/seed/global.db

    (currently some tests assume that svc.configd is run on the global
    zone's seed repository).  If successful, configdctl will print three
    words on a line: a cookie, svc.configd's pid, and svc.configd's door
    path.  Such as

	2145 2148 /tmp/configd_test_2145.door

    Then in another shell attach mdb to svc.configd:

	mdb -p 2148

    Finally run the test, instructing it to connect to svc.configd at the
    given door path.  The libscf tests accept the door path as the only
    argument.  You'll probably need the gate's version of libscf, in which
    case you need to set LD_LIBRARY_PATH, such as to $ROOT/lib.  Since
    I usually do this from the lib/libscf/test directory, I run

	LD_LIBRARY_PATH=$ROOT/lib ./svc_get_propval /tmp/configd_test_2145.door

    When you're done debugging, clean up with
    "configdctl stop <cookie> <pid>", like

	$SRC/common/svc/test/configdctl stop 2145 2148

  - The source also contains ex-situ tests for svccfg in
    cmd/svc/svccfg/test .  Just change to that directory and run
    "./dotests".

  - To test in a nonglobal zone, run the "init_test_zone" script in the
    root of the workspace, as the root user.  It requires the name of the zone
    as an argument.  It copies the files we've changed into the zone,
    including the seed repository.

Repository upgrade:
  For the time being, the extended profiles project is being put on hold.
  Because of this, the code to upgrade the repository is only partially
  complete.  The profiles_repository_upgrade directory contains the design
  notes for upgrading the repository.  This directory contains an asciidoc
  (http://www.methods.co.nz/asciidoc/) source file and a Makefile.  To use
  the Makefile you must have asciidoc and lynx in your path.  Then you can
  type "make html" or "make text".  There also is a clobber target in the
  Makefile.