Refactor setup.py

[turbaszek]

This PR introduces some structure to setup.py by encapsulating
some parts of the logic into functions and creating the main
function.

[turbaszek]

This was never used

[turbaszek]

Installing dependencies for users is a rather bad pattern in my opinion. Users should fix it by running the command that was provided:

pip3 install elasticsearch certifi bcrypt

[Humbedooh]

Telling users to utilize requirements.txt would probably be the best bet here. That way you can also use pipenv easily.

[turbaszek]

Totally agree, I will remove it then - I left it just to preserve the logic

[turbaszek]

Instead of this, we can use default values in argparser arguments

[Humbedooh]

Not opposed to this :) In the longer run, people can always edit the .yaml file later on if they need to make changes. Having it as CLI args would help with automated setups.

[turbaszek]

Having it as CLI args would help with automated setups.

That was the main idea, see #50

[turbaszek]

➜ python setup/setup.py -e 0.0.0.0 -a
Welcome to the Apache Kibble setup script!
Configuring Apache Kibble server with the following arguments:
- hostname: 0.0.0.0
- port: 9200
- dbname: kibble
- shards: 5
- replicas: 1

Creating index kibble_api
Creating index kibble_ci_build
Creating index kibble_ci_queue
Creating index kibble_code_commit
Creating index kibble_code_commit_unique
Creating index kibble_code_modification
Creating index kibble_evolution
Creating index kibble_file_history
Creating index kibble_forum_post
Creating index kibble_forum_topic
Creating index kibble_ghstats
Creating index kibble_im_stats
Creating index kibble_im_ops
Creating index kibble_im_msg
Creating index kibble_issue
Creating index kibble_logstats
Creating index kibble_email
Creating index kibble_mailstats
Creating index kibble_mailtop
Creating index kibble_organisation
Creating index kibble_view
Creating index kibble_publish
Creating index kibble_source
Creating index kibble_stats
Creating index kibble_social_follow
Creating index kibble_social_followers
Creating index kibble_social_follower
Creating index kibble_social_person
Creating index kibble_uisession
Creating index kibble_useraccount
Creating index kibble_message
Creating index kibble_person
Indices created!

Creating administrator account
Account created!

/Users/tomaszurbaszek/kibble/setup/../api/yaml/kibble.yaml already exists! Writing to /Users/tomaszurbaszek/kibble/setup/../api/yaml/kibble.yaml.tmp instead
Writing Kibble config to /Users/tomaszurbaszek/kibble/setup/../api/yaml/kibble.yaml.tmp

All done, Kibble should...work now :)

[turbaszek]

@sharanf @Humbedooh @michalslowikowski00 would love to get a review on this one. Once we are ok with the proposed changes I will adjust the documentation.

[Humbedooh]

Generally for this change. I think we should perhaps also - and this will break the api/ dir a moment, move away from separating host, port, uriprefix and ssl parameters and just accept the standard modern URL parameter instead. That is, http://localhost:9200/ or https://mydb.example.com/ES/ instead of having three or four different variables that pieces it together.

[turbaszek]

That is, http://localhost:9200/ or https://mydb.example.com/ES/ instead of having three or four different variables that pieces it together.

I agree and as a followup I wanted to figure out something around configuration. The rough idea was to abandon the setup script in favor of providing default yaml config and documentation pointing users to change it to suits their needs.

This PR was mostly about improving code and getting familiar with the codebase 👍

[Humbedooh]

We'd still need something to set up the indices, but that could be a non-interactive smaller script.
How about we merge this, and figure out the bigger picture from there on? No harm done in merging and then forgetting this file later on in favor of something new :)

[turbaszek]

We'd still need something to set up the indices, but that could be a non-interactive smaller script.

I think the indices are configured as expected.

How about we merge this, and figure out the bigger picture from there on?

Definitely agree 👍

[Humbedooh]

I'll give it a final look-over later today and merge things then.

[michalslowikowski00]

Nice.

[turbaszek]

@Humbedooh are we ok with moving on with this PR?