docs: updated old commands not longer available starting from 4.11

docs/contributing/db-schema.rst

@@ -1,52 +1,52 b''
 =======================
 DB Schema and Migration
 =======================
 
 To create or alter tables in the database, it's necessary to change a couple of
 files, apart from configuring the settings pointing to the latest database
 schema.
 
 
 Database Model and ORM
 ----------------------
 
 On ``rhodecode.model.db`` you will find the database definition of all tables and 
 fields. Any freshly installed database will be correctly created by the definitions 
 here. So, any change to this file will affect the tests without having to change
 any other file.
 
 A second layer are the business classes inside ``rhodecode.model``. 
 
 
 Database Migration
 ------------------
 
 Three files play a role when creating database migrations:
 
     * Database schema inside ``rhodecode.lib.dbmigrate``
     * Database version inside ``rhodecode.lib.dbmigrate`` 
     * Configuration ``__dbversion__`` at ``rhodecode.__init__``
 
 
 Schema is a snapshot of the database version BEFORE the migration. So, it's
 the initial state before any changes were added. The name convention is
 the latest release version where the snapshot was created, and not the 
 target version of this code.
 
 Version is the method that will define how to UPGRADE/DOWNGRADE the database.
 
 ``rhodecode.__init__`` contains only a variable that defines up to which version of 
 the database will be used to upgrade. Eg.: ``__dbversion__ = 45``
 
 
 For examples on how to create those files, please see the existing code.
 
 
 Migration Command
 ^^^^^^^^^^^^^^^^^
 
 After you've changed the database ORM and migration files, you can run::
 
-   paster upgrade-db <ini-file> 
+   rc-upgrade-db <ini-file>
 
 The database will be upgraded up to the version defined in the ``__init__`` file.
  No newline at end of file

docs/contributing/dev-setup.rst

@@ -1,219 +1,219 b''
 .. _dev-setup:
 
 ===================
  Development setup
 ===================
 
 
 RhodeCode Enterprise runs inside a Nix managed environment. This ensures build
 environment dependencies are correctly declared and installed during setup.
 It also enables atomic upgrades, rollbacks, and multiple instances of RhodeCode
 Enterprise running with isolation.
 
 To set up RhodeCode Enterprise inside the Nix environment, use the following steps:
 
 
 
 Setup Nix Package Manager
 -------------------------
 
 To install the Nix Package Manager, please run::
 
    $ curl https://nixos.org/nix/install | sh
 
 or go to https://nixos.org/nix/ and follow the installation instructions.
 Once this is correctly set up on your system, you should be able to use the
 following commands:
 
 * `nix-env`
 
 * `nix-shell`
 
 
 .. tip::
 
    Update your channels frequently by running ``nix-channel --update``.
 
 
 Switch nix to the latest STABLE channel
 ---------------------------------------
 
 run::
 
    nix-channel --add https://nixos.org/channels/nixos-16.03 nixpkgs
 
 Followed by::
 
    nix-channel --update
 
 
 Install required binaries
 -------------------------
 
 We need some handy tools first.
 
 run::
 
     nix-env -i nix-prefetch-hg
     nix-env -i nix-prefetch-git
 
 
 Clone the required repositories
 -------------------------------
 
 After Nix is set up, clone the RhodeCode Enterprise Community Edition and
 RhodeCode VCSServer repositories into the same directory.
 RhodeCode currently is using Mercurial Version Control System, please make sure
 you have it installed before continuing.
 
 To obtain the required sources, use the following commands::
 
     mkdir rhodecode-develop && cd rhodecode-develop
     hg clone https://code.rhodecode.com/rhodecode-enterprise-ce
     hg clone https://code.rhodecode.com/rhodecode-vcsserver
 
 .. note::
 
    If you cannot clone the repository, please contact us via [e-mail]
 
 
 Install some required libraries
 -------------------------------
 
 There are some required drivers and dev libraries that we need to install to
 test RhodeCode under different types of databases. For example in Ubuntu we
 need to install the following.
 
 required libraries::
 
     sudo apt-get install libapr1-dev libaprutil1-dev
     sudo apt-get install libsvn-dev
     sudo apt-get install mysql-server libmysqlclient-dev
     sudo apt-get install postgresql postgresql-contrib libpq-dev
     sudo apt-get install libcurl4-openssl-dev
 
 
 Enter the Development Shell
 ---------------------------
 
 The final step is to start the development shells. To do this, run the
 following command from inside the cloned repository::
 
    #first, the vcsserver
    cd ~/rhodecode-vcsserver
    nix-shell
 
    # then enterprise sources
    cd ~/rhodecode-enterprise-ce
    nix-shell
 
 .. note::
 
    On the first run, this will take a while to download and optionally compile
    a few things. The following runs will be faster. The development shell works
    fine on both MacOS and Linux platforms.
 
 
 Create config.nix for development
 ---------------------------------
 
 In order to run proper tests and setup linking across projects, a config.nix
 file needs to be setup::
 
     # create config
     mkdir -p ~/.nixpkgs
     touch ~/.nixpkgs/config.nix
 
     # put the below content into the ~/.nixpkgs/config.nix file
     # adjusts, the path to where you cloned your repositories.
 
     {
       rc = {
        sources = {
         rhodecode-vcsserver = "/home/dev/rhodecode-vcsserver";
         rhodecode-enterprise-ce = "/home/dev/rhodecode-enterprise-ce";
         rhodecode-enterprise-ee = "/home/dev/rhodecode-enterprise-ee";
        };
       };
     }
 
 
 
 Creating a Development Configuration
 ------------------------------------
 
 To create a development environment for RhodeCode Enterprise,
 use the following steps:
 
 1. Create a copy of vcsserver config:
     `cp ~/rhodecode-vcsserver/configs/development.ini ~/rhodecode-vcsserver/configs/dev.ini`
 2. Create a copy of rhodocode config:
     `cp ~/rhodecode-enterprise-ce/configs/development.ini ~/rhodecode-enterprise-ce/configs/dev.ini`
 3. Adjust the configuration settings to your needs if needed.
 
 .. note::
 
   It is recommended to use the name `dev.ini` since it's included in .hgignore file.
 
 
 Setup the Development Database
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To create a development database, use the following example. This is a one
 time operation executed from the nix-shell of rhodecode-enterprise-ce sources ::
 
-    paster setup-rhodecode dev.ini \
+    rc-setup-app dev.ini \
         --user=admin --password=secret \
         --email=[e-mail] \
         --repos=~/my_dev_repos
 
 
 Compile CSS and JavaScript
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To use the application's frontend and prepare it for production deployment,
 you will need to compile the CSS and JavaScript with Grunt.
 This is easily done from within the nix-shell using the following command::
 
     grunt
 
 When developing new features you will need to recompile following any
 changes made to the CSS or JavaScript files when developing the code::
 
     grunt watch
 
 This prepares the development (with comments/whitespace) versions of files.
 
 Start the Development Servers
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 From the rhodecode-vcsserver directory, start the development server in another
 nix-shell, using the following command::
 
       pserve configs/dev.ini
 
 In the adjacent nix-shell which you created for your development server, you may
 now start CE with the following command::
 
 
       pserve --reload configs/dev.ini
 
 .. note::
 
   `--reload` flag will automatically reload the server when source file changes.
 
 
 Run the Environment Tests
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Please make sure that the tests are passing to verify that your environment is
 set up correctly. RhodeCode uses py.test to run tests.
 While your instance is running, start a new nix-shell and simply run
 ``make test`` to run the basic test suite.
 
 
 Need Help?
 ^^^^^^^^^^
 
 Join us on Slack via https://rhodecode.com/join or post questions in our
 Community Portal at https://community.rhodecode.com

release.nix

@@ -1,232 +1,232 b''
 #
 # About
 # =====
 #
 # This file defines jobs for our CI system and the attribute "build" is used
 # as the input for packaging.
 #
 #
 # CI details
 # ==========
 #
 # This file defines an attribute set of derivations. Each of these attributes is
 # then used in our CI system as one job to run. This way we keep the
 # configuration for the CI jobs as well under version control.
 #
 # Run CI jobs locally
 # -------------------
 #
 # Since it is all based on normal Nix derivations, the jobs can be tested
 # locally with a run of "nix-build" like the following example:
 #
 #    nix-build release.nix -A test-api -I vcsserver=~/rhodecode-vcsserver
 #
 # Note: Replace "~/rhodecode-vcsserver" with a path where a clone of the
 # vcsserver resides.
 
 { pkgs ? import <nixpkgs> {}
 , doCheck ? true
 }:
 
 let
 
   inherit (pkgs)
     stdenv
     system;
 
   testing = import <nixpkgs/nixos/lib/testing.nix> {
     inherit system;
   };
 
   runInMachine = testing.runInMachine;
 
   sphinx = import ./docs/default.nix {};
 
   mkDocs = kind: stdenv.mkDerivation {
     name = kind;
     srcs = [
       (./. + (builtins.toPath "/${kind}"))
       (builtins.filterSource
         (path: type: baseNameOf path == "VERSION")
         ./rhodecode)
     ];
     sourceRoot = kind;
     buildInputs = [ sphinx ];
     configurePhase = null;
     buildPhase = ''
       make SPHINXBUILD=sphinx-build html
     '';
     installPhase = ''
       mkdir -p $out
       mv _build/html $out/
 
       mkdir -p $out/nix-support
       echo "doc manual $out/html index.html" >> \
         "$out/nix-support/hydra-build-products"
     '';
   };
 
   enterprise = import ./default.nix {
     inherit
       pkgs;
 
     # TODO: for quick local testing
     doCheck = false;
   };
 
   test-cfg = stdenv.mkDerivation {
     name = "test-cfg";
     unpackPhase = "true";
     buildInputs = [
       enterprise.src
     ];
     installPhase = ''
       mkdir -p $out/etc
       cp ${enterprise.src}/test.ini $out/etc/enterprise.ini
       # TODO: johbo: Needed, so that the login works, this causes
       # probably some side effects
       substituteInPlace $out/etc/enterprise.ini --replace "is_test = True" ""
 
       # Gevent configuration
       cp $out/etc/enterprise.ini $out/etc/enterprise-gevent.ini;
       cat >> $out/etc/enterprise-gevent.ini <<EOF
 
       [server:main]
       use = egg:gunicorn#main
       worker_class = gevent
       EOF
 
       cp ${enterprise.src}/vcsserver/test.ini $out/etc/vcsserver.ini
     '';
   };
 
   ac-test-drv = import ./acceptance_tests {
     withExternals = false;
   };
 
   # TODO: johbo: Currently abusing buildPythonPackage to make the
   # needed environment for the ac-test tools.
   mkAcTests = {
     # Path to an INI file which will be used to run Enterprise.
     #
     # Intended usage is to provide different configuration files to
     # run the tests against a different configuration.
     enterpriseCfg ? "${test-cfg}/etc/enterprise.ini"
 
     # Path to an INI file which will be used to run the VCSServer.
   , vcsserverCfg ? "${test-cfg}/etc/vcsserver.ini"
   }: pkgs.pythonPackages.buildPythonPackage {
     name = "enterprise-ac-tests";
     src = ./acceptance_tests;
 
     buildInputs = with pkgs; [
       curl
       enterprise
       ac-test-drv
     ];
 
     buildPhase = ''
       cp ${enterpriseCfg} enterprise.ini
 
       echo "Creating a fake home directory"
       mkdir fake-home
       export HOME=$PWD/fake-home
 
       echo "Creating a repository directory"
       mkdir repos
 
       echo "Preparing the database"
-      paster setup-rhodecode \
+      rc-setup-app \
         --user=admin \
         --email=[e-mail] \
         --password=secret \
         --api-key=9999999999999999999999999999999999999999 \
         --force-yes \
         --repos=$PWD/repos \
         enterprise.ini > /dev/null
 
       echo "Starting rc-server"
       vcsserver --config ${vcsserverCfg} >vcsserver.log 2>&1 &
       rc-server enterprise.ini >rc-server.log 2>&1 &
 
       while ! curl -f -s http://localhost:5000 > /dev/null
       do
           echo "Waiting for server to be ready..."
           sleep 3
       done
       echo "Webserver is ready."
 
       echo "Starting the test run"
       py.test -c example.ini -vs --maxfail=5 tests
 
       echo "Kill rc-server"
       kill %2
       kill %1
     '';
 
     # TODO: johbo: Use the install phase again once the normal mkDerivation
     # can be used again.
     postInstall = ''
       mkdir -p $out
       cp enterprise.ini $out
       cp ${vcsserverCfg} $out/vcsserver.ini
       cp rc-server.log $out
       cp vcsserver.log $out
 
       mkdir -p $out/nix-support
       echo "report config $out enterprise.ini" >> $out/nix-support/hydra-build-products
       echo "report config $out vcsserver.ini" >> $out/nix-support/hydra-build-products
       echo "report rc-server $out rc-server.log" >> $out/nix-support/hydra-build-products
       echo "report vcsserver $out vcsserver.log" >> $out/nix-support/hydra-build-products
     '';
   };
 
   vcsserver = import <vcsserver> {
     inherit pkgs;
 
     # TODO: johbo: Think of a more elegant solution to this problem
     pythonExternalOverrides = self: super: (enterprise.myPythonPackagesUnfix self);
   };
 
   runTests = optionString: (enterprise.override (attrs: {
     doCheck = true;
     name = "test-run";
     buildInputs = attrs.buildInputs ++ [
       vcsserver
     ];
     checkPhase = ''
       py.test ${optionString} -vv -ra
     '';
     buildPhase = attrs.shellHook;
     installPhase = ''
       echo "Intentionally not installing anything"
     '';
     meta.description = "Enterprise test run ${optionString}";
   }));
 
   jobs = {
 
     build = enterprise;
 
     # johbo: Currently this is simply running the tests against the sources. Nicer
     # would be to run xdist and against the installed application, so that we also
     # cover the impact of installing the application.
     test-api = runTests "rhodecode/api";
     test-functional = runTests "rhodecode/tests/functional";
     test-rest = runTests "rhodecode/tests --ignore=rhodecode/tests/functional";
     test-full = runTests "rhodecode";
 
     docs = mkDocs "docs";
 
     aggregate = pkgs.releaseTools.aggregate {
       name = "aggregated-jobs";
       constituents = [
         jobs.build
         jobs.test-api
         jobs.test-rest
         jobs.docs
       ];
     };
   };
 
 in jobs