Merge pull request #101 from TTWShell/feature/init-dev-cmd

Feature/init dev cmd

Author: TTWShell

hobbit/__init__.py

@@ -29,7 +29,7 @@ def format_options(self, ctx, formatter):
                 formatter.write_dl(opts)
 
 
-class CLI(click.Group, HobbitCommand):
+class HobbitGroup(click.Group, HobbitCommand):
 
     def list_commands(self, ctx):
         return sorted(self.cmds.keys())
@@ -47,8 +47,10 @@ def get_command(self, ctx, cmd_name):
 
     @property
     def cmds(self):
-        from . import bootstrap
-        return {func.name: func for func in bootstrap.CMDS}
+        from .bootstrap import cmd_list
+        from .devtools import dev
+        cmd_list.append(dev)
+        return {func.name: func for func in cmd_list}
 
     def format_options(self, ctx, formatter):
         HobbitCommand.format_options(self, ctx, formatter)
@@ -90,7 +92,7 @@ def format_commands(self, ctx, formatter):
 
 
 @click.group(
-    cls=CLI,
+    cls=HobbitGroup,
     epilog='More details: https://hobbit-core.readthedocs.io/zh/latest/',
     context_settings=CONTEXT_SETTINGS)
 @click.version_option()

hobbit/bootstrap.py

@@ -5,13 +5,19 @@
 
 import click
 
-from .handlers.bootstrap import echo, render_project, gen_metadata_by_name, \
+from .handlers import echo
+from .handlers.bootstrap import render_project, gen_metadata_by_name, \
     validate_template_path, validate_csv_file, MetaModel, create_models_csv
-from . import HobbitCommand, main as cli
+from . import HobbitCommand, HobbitGroup, CONTEXT_SETTINGS
 
 templates = ['shire', 'rivendell']
 
 
+@click.group(cls=HobbitGroup, context_settings=CONTEXT_SETTINGS)
+def cli():
+    pass
+
+
 def common_options(func):
     func = click.option(
         '-f', '--force', default=False, is_flag=True,
@@ -114,4 +120,4 @@ def create(ctx, name):
     create_models_csv(name)
 
 
-CMDS = [new, gen, create]
+cmd_list = [new, gen, create]

hobbit/devtools.py

@@ -0,0 +1,31 @@
+import click
+
+from . import HobbitGroup, CONTEXT_SETTINGS
+from .handlers.devtools import dev_init
+
+
+class BootstrapGroup(HobbitGroup):
+
+    @property
+    def cmds(self):
+        return {func.name: func for func in [init]}
+
+
+@click.group(cls=BootstrapGroup, context_settings=CONTEXT_SETTINGS)
+def dev():
+    """Dev tools, more: hobbit dev --help.
+    """
+    pass
+
+
+@dev.command()
+@click.option('-a', '--all', 'all_', default=False, is_flag=True,
+              help='Run all.')
+@click.option('--hooks', default=False, is_flag=True, help='Install hooks.')
+@click.option('--pipenv', default=False, is_flag=True,
+              help='Create virtualenv by pipenv.')
+@click.pass_context
+def init(ctx, all_, hooks, pipenv):
+    """Init dev env: git hooks, pyenv install etc.
+    """
+    dev_init(all_, hooks, pipenv)

hobbit/handlers/__init__.py

@@ -0,0 +1,8 @@
+import click
+
+
+@click.pass_context
+def echo(ctx, msg):
+    if not ctx.obj['ECHO']:
+        return
+    click.echo(msg)

hobbit/handlers/bootstrap.py

@@ -8,6 +8,7 @@
 from jinja2 import Environment, FileSystemLoader, Template
 
 from hobbit import inflect_engine
+from . import echo
 
 SUFFIX = '.jinja2'
 
@@ -17,13 +18,6 @@ def regex_replace(s, find, replace):
     return re.sub(find, replace, s)
 
 
-@click.pass_context
-def echo(ctx, msg):
-    if not ctx.obj['ECHO']:
-        return
-    click.echo(msg)
-
-
 @contextmanager
 def chdir(dist):
     cwd = os.getcwd()

hobbit/handlers/devtools.py

@@ -0,0 +1,36 @@
+import os
+import sys
+from subprocess import run, PIPE, STDOUT
+
+import click
+
+from hobbit import ROOT_PATH
+
+
+def dev_init(all_, hooks, pipenv):
+    run('git init', shell=True)
+
+    if all_ or hooks:
+        HOOKS_PATH = os.path.join(ROOT_PATH, 'static', 'hooks')
+        run(f'cp -r {HOOKS_PATH}/* .git/hooks', shell=True)
+
+    if all_ or pipenv:
+        sub = run('which pipenv', shell=True, stdout=PIPE, stderr=STDOUT)
+        if sub.returncode != 0:
+            click.echo(click.style('cmd pipenv not exist.', fg='red'))
+            sys.exit(sub.returncode)
+        pipenv_path = sub.stdout.strip().decode('utf8')
+
+        pipenv_cmds = [
+            f'{pipenv_path} install --dev pytest pytest-cov pytest-env flake8',
+        ]
+        if 'requirements.txt' in os.listdir():
+            pipenv_cmds.insert(
+                0, f'{pipenv_path} install -r requirements.txt --pre')
+
+        cmd = ' && '.join(pipenv_cmds)
+        click.echo(click.style(cmd, fg='green'))
+        # force pipenv to ignore that environment and create its own instead
+        env = os.environ.copy()
+        env.update({'PIPENV_IGNORE_VIRTUALENVS': '1'})
+        run(cmd, shell=True, env=env)

hobbit/static/hooks/commit-msg

@@ -0,0 +1,44 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+CURRENT_BRANCH=`git branch | grep \* | cut -d ' ' -f2`
+JIRA_ID_REGEX='[A-Za-z0-9]+-[0-9]+'
+JIRA_ID=`echo $CURRENT_BRANCH | grep -oE '${JIRA_ID_REGEX}$'`
+if [[ -z $JIRA_ID ]]; then
+    echo "Warning: 'jira id' not found in current branch name, example: feature/test-SKYF-458"
+fi
+
+COMMENT=`cat $1 | head -n 1`
+if [[ -z $COMMENT ]]; then
+    echo "Error: comment can't be empty"
+    exit 1
+fi
+
+hasHead=`echo $COMMENT | grep -oE '^\(${JIRA_ID_REGEX}\)'`
+if [[ -z $hasHead && ! -z $JIRA_ID ]]; then
+    COMMENT_TAIL=`tail -n +2 $1`
+    COMMENT="($JIRA_ID) $COMMENT\n${COMMENT_TAIL}"
+    printf "$COMMENT" > "$1"
+fi
+
+isOK=`echo $COMMENT | grep -oE '^\(${JIRA_ID_REGEX}\) .+'`
+if [[ -z $isOK ]]; then
+    echo "Error: comment should be in format: (jira-id) comment msg. Example: (SKYF-458) finished xx"
+    exit 1
+fi

hobbit/static/hooks/pre-commit

@@ -0,0 +1 @@
+flake8 . --max-line-length=120

setup.py

@@ -10,7 +10,7 @@
 def gen_data(data_root='static'):
     """just for collect static files.
     """
-    return [fpath for fpath in Path(
+    return [fpath.as_posix() for fpath in Path(
         PurePath(src_path) / data_root).glob(f'**/*{SUFFIX}')]
 
 

tests/test_hobbit.py

@@ -92,9 +92,7 @@ def test_new_rivendell_tpl_and_gen_cmd(self, runner, gen_cmd, csv_file):
         assert os.getcwd() == self.wkdir
 
         # new project use rivendell template
-        cmd = [
-            '--echo', 'new', '-n', 'haha', '-p', '1024',
-            '-t', 'rivendell']
+        cmd = ['--echo', 'new', '-n', 'haha', '-p', '1024', '-t', 'rivendell']
         result = runner.invoke(hobbit, cmd, obj={})
         # start + files + mkdir + tail
         assert result.exit_code == 0
@@ -109,3 +107,13 @@ def test_new_rivendell_tpl_and_gen_cmd(self, runner, gen_cmd, csv_file):
         # pytest
         assert subprocess.call(
             ['pytest', '--no-cov'], stdout=subprocess.DEVNULL) == 0
+
+    @chdir(wkdir)
+    def test_dev_init_cmd(self, runner):
+        # new project use rivendell template
+        cmd = ['--echo', 'new', '-n', 'haha', '-p', '1024', '-t', 'rivendell']
+        result = runner.invoke(hobbit, cmd, obj={})
+        assert result.exit_code == 0
+
+        result = runner.invoke(hobbit, ['dev', 'init', '--all'], obj={})
+        assert result.exit_code == 0, result.output