contrib/utils/testconf

   1 #!/bin/bash
   2
   3 # this is meant to be run on your *client* (where you edit and commit files
   4 # in a gitolite-admin *working* repo), not on the gitolite server.
   5 #
   6 # TO USE
   7 # ======
   8
   9 # To use this, first upgrade gitolite to the latest on the server; you need at
  10 # least v3.6.7.
  11 #
  12 # Then, on the client:
  13 #
  14 #   1.  copy this file (contrib/utils/testconf in the latest gitolite) to
  15 #       somewhere in your $PATH
  16 #   2.  modify the following lines if you wish (default should be fine for
  17 #       most people):
  18
  19     # a semi-permanent area to play in (please delete it manually if you want to start afresh).
  20     testconf=$HOME/GITOLITE-TESTCONF
  21     # the gitolite source code
  22     gitolite_url=https://github.com/sitaramc/gitolite
  23
  24 #   3.  go to your gitolite-admin clone and make suitable changes; see example
  25 #       below.  No need to push to the server, yet.
  26 #   4.  run 'testconf`
  27 #
  28 # CAVEAT: include files are not handled the same way gitolite parsing handles
  29 # them -- we just cat all the conf files together, in sorted order.
  30 #
  31 # If the tests ran OK, push your changes to the server as usual.
  32
  33 # EXAMPLE changes to gitolite.conf
  34 # ================================
  35 # Say you have these rules in the conf file:
  36 #
  37 #     repo foo
  38 #         R       =   u1
  39 #         RW      =   u2
  40 #         RW+     =   u3
  41 #
  42 # To create test code for this, add the following lines to the conf file.
  43 #
  44 #     =begin testconf
  45 #     # you can put arbitrary bash code here, but a simple example follows
  46 #
  47 #     ok() { "$@" && echo ok || echo "not ok ($*)"; }
  48 #     nok() { ! "$@" && echo ok || echo "not ok ($*)"; }
  49 #
  50 #     ok gitolite access -q foo u1 R
  51 #     nok gitolite access -q foo u1 W
  52 #
  53 #     ok gitolite access -q foo u2 W
  54 #     nok gitolite access -q foo u2 +
  55 #
  56 #     ok gitolite access -q foo u3 +
  57 #     =end
  58 #
  59 # Note that you can actually put in any bash code between the 'begin' and
  60 # 'end' lines; the above is just a useful sample/template.
  61 #
  62 # Because of the 'begin' and 'end' lines, gitolite will ignore those lines
  63 # when processing the conf file ON THE SERVER.
  64 #
  65 # (optional) TAP compliance
  66 # =========================
  67 # if you add a line 'echo 1..5' (in this case, since there are 5 ok/nok lines;
  68 # you will certainly have more) to the top the file, you can run
  69 #
  70 #   prove `which testconf`
  71 #
  72 # which will give you a much nicer output.  The only issue is if you have
  73 # include files, you will need to put that in the file whose name is sorted
  74 # first!
  75 #
  76 # Using a non-default ".gitolite.rc"
  77 # ==================================
  78 #
  79 # If your conf needs a non-default `~/.gitolite.rc`, copy the file you need as
  80 # "testconf.gitolite.rc" in the root directory of the gitolite-admin clone
  81 # where you are running "testconf".  (Whether you commit this file to the
  82 # gitolite-admin repo, or keep it local/untracked, is your call).
  83
  84 # ----------------------------------------------------------------------
  85 od=$PWD
  86
  87 # prep
  88
  89 mkdir -p $testconf
  90 cd $testconf
  91
  92 export HOME=$PWD
  93 export PATH=$PWD/gitolite/src:$PATH
  94
  95 [ -d gitolite ] || {
  96
  97     echo getting gitolite source...
  98     git clone $gitolite_url gitolite
  99     echo
 100
 101     echo installing gitolite...
 102     gitolite/install >/dev/null
 103     echo
 104
 105     echo setting up gitolite...
 106     gitolite setup -a admin
 107     echo
 108
 109 }
 110
 111 # copy conf from $od
 112
 113 rm -rf           $testconf/.gitolite/conf
 114 mkdir -p         $testconf/.gitolite/conf
 115 cp -a $od/conf/* $testconf/.gitolite/conf/
 116
 117 # copy rc from $od, if it exists
 118 [ -f $od/testconf.gitolite.rc ] && cp $od/testconf.gitolite.rc $testconf/.gitolite.rc
 119
 120 # compile+
 121
 122 gitolite compile
 123 gitolite trigger POST_COMPILE
 124
 125 # snarf bits of code from conf files and run them
 126
 127 cat `find $testconf/.gitolite/conf -type f -name "*.conf" | sort` |
 128     perl -ne '
 129         print if /^=begin testconf$/ .. /^=end$/ and not /^=(begin|end)/;
 130     ' | /bin/bash