cEP-0017.md: cEP describing design of cib #117

saksham189 · 2018-05-05T14:42:45Z

Closes #10

gitmate-bot · 2018-05-05T14:43:05Z

cEP-0017.md

+
+# Abstract
+
+This cEP describes the design of the cib tool which will allow it to install 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -12,7 +12,7 @@ # Abstract -This cEP describes the design of the cib tool which will allow it to install +This cEP describes the design of the cib tool which will allow it to install individual bears and their dependencies easily. The cEP also suggests changes to Requirement classes and using conda packages

gitmate-bot · 2018-05-05T14:43:06Z

cEP-0017.md

+# Abstract
+
+This cEP describes the design of the cib tool which will allow it to install 
+individual bears and their dependencies easily. 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -13,7 +13,7 @@ # Abstract This cEP describes the design of the cib tool which will allow it to install -individual bears and their dependencies easily. +individual bears and their dependencies easily. The cEP also suggests changes to Requirement classes and using conda packages for bears such as DartLintBear.

gitmate-bot · 2018-05-05T14:43:07Z

cEP-0017.md

+The current design of the cib tool allows it to perform basic operations such as
+running pip install on bears and then checking their dependencies. However, the
+design of the cib tool needs to be able to handle other special cases such as of
+bears that have different installation instructions for each distribution such as 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -24,7 +24,7 @@ The current design of the cib tool allows it to perform basic operations such as running pip install on bears and then checking their dependencies. However, the design of the cib tool needs to be able to handle other special cases such as of -bears that have different installation instructions for each distribution such as +bears that have different installation instructions for each distribution such as DartLintBear and bears that have bear dependencies. Additionally, the tool should also be able to provide verbose output, ask user for

gitmate-bot · 2018-05-05T14:43:08Z

cEP-0017.md

+running pip install on bears and then checking their dependencies. However, the
+design of the cib tool needs to be able to handle other special cases such as of
+bears that have different installation instructions for each distribution such as 
+DartLintBear and bears that have bear dependencies. 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -25,7 +25,7 @@ running pip install on bears and then checking their dependencies. However, the design of the cib tool needs to be able to handle other special cases such as of bears that have different installation instructions for each distribution such as -DartLintBear and bears that have bear dependencies. +DartLintBear and bears that have bear dependencies. Additionally, the tool should also be able to provide verbose output, ask user for permission before proceeding and install bears related to a specific language.

gitmate-bot · 2018-05-05T14:43:09Z

cEP-0017.md

+bears that have different installation instructions for each distribution such as 
+DartLintBear and bears that have bear dependencies. 
+
+Additionally, the tool should also be able to provide verbose output, ask user for 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -27,7 +27,7 @@ bears that have different installation instructions for each distribution such as DartLintBear and bears that have bear dependencies. -Additionally, the tool should also be able to provide verbose output, ask user for +Additionally, the tool should also be able to provide verbose output, ask user for permission before proceeding and install bears related to a specific language.

gitmate-bot · 2018-05-05T14:43:10Z

cEP-0017.md

+
+Here is the procedure for the installation of the bears:
+
+1. Identify the valid bear names that need to be installed as specified by the 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -35,7 +35,7 @@ Here is the procedure for the installation of the bears: -1. Identify the valid bear names that need to be installed as specified by the +1. Identify the valid bear names that need to be installed as specified by the user on the command line. 2. Install bear on the valid bear names. We will run commands from CondaRequirement to check whether the package is uploaded to anaconda.org and then check whether

gitmate-bot · 2018-05-05T14:43:10Z

cEP-0017.md

+2. Install bear on the valid bear names. We will run commands from CondaRequirement
+to check whether the package is uploaded to anaconda.org and then check whether
+it can be installed from PyPi using PipRequirement.
+    * This will require to create conda packages for bears that have different 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -40,7 +40,7 @@ 2. Install bear on the valid bear names. We will run commands from CondaRequirement to check whether the package is uploaded to anaconda.org and then check whether it can be installed from PyPi using PipRequirement. - * This will require to create conda packages for bears that have different + * This will require to create conda packages for bears that have different installation instructions for each distribution. This is done by making `bld.bat` file that has installation instruction for Windows and similarly a `bld.sh` file that has installation instruction for Linux.

gitmate-bot · 2018-05-05T14:43:11Z

cEP-0017.md

+    installation instructions for each distribution. This is done by making `bld.bat`
+    file that has installation instruction for Windows and similarly a `bld.sh` file
+    that has installation instruction for Linux.
+3. After installing the bear we proceed to installing its requirements. We call 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -44,7 +44,7 @@ installation instructions for each distribution. This is done by making `bld.bat` file that has installation instruction for Windows and similarly a `bld.sh` file that has installation instruction for Linux. -3. After installing the bear we proceed to installing its requirements. We call +3. After installing the bear we proceed to installing its requirements. We call methods from the requirement classes to do this. * Add new Requirement classes to support different dependencies from various linters. * The DistributionRequirement class needs to be split into different classes for each

gitmate-bot · 2018-05-05T14:43:12Z

cEP-0017.md

+3. After installing the bear we proceed to installing its requirements. We call 
+methods from the requirement classes to do this.
+    * Add new Requirement classes to support different dependencies from various linters.
+    * The DistributionRequirement class needs to be split into different classes for each 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -47,7 +47,7 @@ 3. After installing the bear we proceed to installing its requirements. We call methods from the requirement classes to do this. * Add new Requirement classes to support different dependencies from various linters. - * The DistributionRequirement class needs to be split into different classes for each + * The DistributionRequirement class needs to be split into different classes for each package manager and call its method to introduct more consistency. 4. We then proceed to install bear dependencies such as for ClangCloneDetectionBear by running `install_bears` method on each dependency bear.

gitmate-bot · 2018-05-05T14:43:13Z

cEP-0017.md

+    * Add new Requirement classes to support different dependencies from various linters.
+    * The DistributionRequirement class needs to be split into different classes for each 
+    package manager and call its method to introduct more consistency.
+4. We then proceed to install bear dependencies such as for ClangCloneDetectionBear by 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpobuqqos9/cEP-0017.md +++ b/tmp/tmpobuqqos9/cEP-0017.md @@ -49,7 +49,7 @@ * Add new Requirement classes to support different dependencies from various linters. * The DistributionRequirement class needs to be split into different classes for each package manager and call its method to introduct more consistency. -4. We then proceed to install bear dependencies such as for ClangCloneDetectionBear by +4. We then proceed to install bear dependencies such as for ClangCloneDetectionBear by running `install_bears` method on each dependency bear.

jayvdb

Closes #10 pls

jayvdb · 2018-05-07T04:25:14Z

cEP-0017.md

+This cEP describes the design of the cib tool which will allow it to install
+individual bears and their dependencies easily.
+
+The cEP also suggests changes to  Requirement classes and using conda packages


repeated spaces.
Also Requirement should be in backticks. Lots of backticks needed throughout this cEP

jayvdb · 2018-05-07T04:26:33Z

cEP-0017.md

+Here is the procedure for the installation of the bears:
+
+1. Identify the valid bear names that need to be installed as specified by the
+user on the command line.


indent.

please run markdownbear / remark on your .md.

jayvdb · 2018-05-07T04:33:37Z

I would dearly love to see https://github.com/coala/coala-bears/blob/master/bears/generate_package.py moved from coala-bears to a different location. it could be coala, cib, dependency_management. I really dont care. Ah, coala/coala-bears#1199 is the related issue in that repo. And PEP 420 (coala/coala#3545) is why I want it removed .. ;-)

Also I would like to see some evaluation of https://github.com/mbodenhamer/depman (who is a co-mentor on this project) to see if some of its functionality may help this project.

jayvdb

Please specify the user interface.

And indicate scenarios of usage which will work.

Note any which will not work, because they cant, or because they are too complex and are out of scope for this project.

What are the minimum requirements for it to work?

Will cib work on Alpine Linux with only python, coala and cib installed? Or does coala-bears need to be installed?

ishanSrt

useful feature, and an add-on for cib coala/coala#5456

xferra · 2018-05-11T11:32:27Z

Before performing review itself I would like to raise several questions/topics; if they're out of the scope please just skip it; if it could be a critical open question - I suggest to mention it in the doc:

What is the versioning strategy? How is tool version connected with coala version and linter version?
What is the release strategy? The upgrade process for meta-packages and tool is also unclear;
Global dependencies; it may require root access;
Rollback or uninstall process;
Conflicting dependencies (let's say system-wide dependency that doesn't support multiple global installations);
The same liner may be officially distributed via different package managers; what source to choose? ()
Will it be possible to prepare docker image for concrete list of linters with all requirements installed but without this tool? (coz it's not needed in runtime, only on preparation step);
How to interact with the user? Let's say installation requires: 1) root access, and command executed via terminal internally, how to ask the user for login/pass? 2) I can imagine less complex scenarios, like confirmations ''type 'Y' to continue" are in place;
Licenses. What to do with linter which will not allow the distribution process described in this doc?

xferra

Please address my questions above (we can also discuss it in gitter, but then duplicate answers there).

saksham189 · 2018-05-11T19:18:09Z

We could get the password using
import getpass getpass.getpass('Password:')
if root access is required.

If more than 1 package managers are available to install the linter on the platform, I think we could simply chose any 1 and continue. But if we should be giving a higher priority to any one such as apt-get over yum then they could be arranged in that order of priority.

For conflicting dependencies, print a warning to the user regarding the conflict or simply putting out verbose output of running the command.

saksham189 · 2018-05-30T14:31:36Z

@Udayan12167 please review

pareksha · 2018-06-01T08:51:12Z

cEP-0017.md

+1. Create a new repository called `coala-bear packages`.
+2. This repository will have a folder called `conda packages` that contains conda packages for
+   all the bears that require different installation instructions on each distribution. Each
+   conda package requires 3 files i.e. `meta.yaml`, `build.sh`, `bld.bat`.


Above (line 90) you have mentioned bld.sh and here it is build.sh. You should stick to one name.

virresh · 2018-06-06T15:20:27Z

cEP-0017.md

+
+### Splitting `DistributionRequirement`
+
+```


You can use syntax highlighting for Python using ```python

virresh · 2018-06-06T15:21:50Z

cEP-0017.md

+
+### Package Requirement
+
+```


Syntax can be highlighted using ```yaml

e.g

- pip: name: package_name version: 0.11

jayvdb · 2018-06-07T21:43:35Z

cEP-0017.md

+
+1. Identify the valid bear names that need to be installed as specified by the
+   user on the command line.
+2. Install bear on the valid bear names. We will run commands from `CondaRequirement`


remove We and other pronouns. Here "we" refers to "cib"?

jayvdb · 2018-06-07T21:43:54Z

cEP-0017.md

+
+## Introduction
+
+The current design of the cib tool allows it to perform basic operations such as


consistent backticks for cib pls

jayvdb · 2018-06-07T21:45:09Z

cEP-0017.md

+
+Another alternative to `cib` that can be used for installing bears and their dependencies
+is Ansible. Ansible allows to orchestrate steps of any process
+for different distributions by creating `playbooks` in YAML.


playbooks isnt a code literal -- it is a English term created by Ansible, so should be in double quotes "playbooks"

jayvdb · 2018-06-07T21:46:00Z

cEP-0017.md

+
+Ansible provides numerous
+[packaging modules](http://docs.Ansible.com/Ansible/latest/modules/list_of_packaging_modules.html)
+that can be used to install dependencies of `Bears`.


-> "Bears" - terminology coala created

jayvdb · 2018-06-07T21:48:11Z

cEP-0017.md

+1. Identify the valid bear names that need to be installed as specified by the
+   user on the command line.
+2. Install bear on the valid bear names. We will run commands from `CondaRequirement`
+   to check whether the package is uploaded to `Anaconda.org` and then check whether


Anaconda.org should be a link.

Why only Anaconda.org ? That is only one group of channels/respositories.

There are others, like Bioconda, which are more open.

The bioconda channel is a Conda channel providing bioinformatics related packages for Linux and Mac OS.

We don't want to use the bioconda channel. I will investigate more on other channels or creating a new channel.

jayvdb · 2018-06-07T21:55:18Z

cEP-0017.md

+
+        choice = raw_input().lower()
+        if  choice  in  consts.TRUE_STRINGS:
+            return   True


consecutive spaces .. eww

jayvdb · 2018-06-07T21:55:57Z

cEP-0017.md

+
+    REQUIREMENTS = {}
+
+    def __init__(self, platform: str, package: str, version="", repo=""):


single quotes for string literals (everywhere).

jayvdb · 2018-06-07T21:58:03Z

cEP-0017.md

+        raise NotImplementedError
+
+    @lru_cache()
+    def get_platform():


this should be a class method, otherwise each subclass will have its own lru_cache.

jayvdb · 2018-06-07T21:59:03Z

cEP-0017.md

+    version: 0.11
+```
+
+This can be used to install the `pip` dependencies for `Bears`. Ansible currently


jayvdb · 2018-06-07T22:01:40Z

cEP-0017.md

+`GNUIndentBear` that uses a `DistributionRequirement` as shown:
+
+```python
+REQUIREMENTS = {DistributionRequirement('indent')}


need an example which needs a specific version.

ArtisticStyleBear is a better example

ArtisticStyleBear doesn't mention a version

jayvdb · 2018-06-12T06:23:22Z

cEP-0017.md

+            return True
+        elif choice in consts.FALSE_STRINGS:
+            return False
+        else :


extra space.

please run your sample code through pyflakes and pycodestyle

jayvdb · 2018-06-12T06:35:14Z

cEP-0017.md

+
+- name: Install bear_name
+  package: >
+    name={{ bear_name }}


bear_name isnt a good variable name for a dependency.

{{<program_name>}} would be more intuitive.
e.g.

name={{yamllint}}

Also, bears can have multiple dependencies, so any 1:1 relationship in names should be avaoided.

and if we ever add the second yamllint (ruby iirc) in a second bear, then we can simply use a different name, without it looking too weird.

name={{ruby_yamllint}}

yes that is a mistake
it should have been {{ package_name }}

jayvdb · 2018-06-12T06:36:43Z

cEP-0017.md

+
+    @classmethod
+    @lru_cache()
+    def get_platform():


a class method must take an argument cls.

jayvdb · 2018-06-12T06:36:51Z

cEP-0017.md

+    def get_platform():
+        return platform.system(), distro.id()
+
+    def check_platform():


arg self missing

Closes coala#10

jayvdb · 2018-06-12T10:38:35Z

cEP-0017.md

+def install_bears(bear_names_list):
+    bear_failed_list = []
+    for bear_name in bear_names_list:
+        if PipRequirement(bear_name).is_installed() or \


In the real code, please avoid \.

jayvdb · 2018-06-12T10:38:48Z

cEP-0017.md

+            print(bear_name + ' is already installed.')
+            continue
+        if not PipRequirement(bear_name).install_package() or \
+           not CondaRequirement(bear_name).install_package():


this indentation is not OK for real code.

see PEP8 for explanation

jayvdb · 2018-06-12T10:40:41Z

cEP-0017.md

+        """
+        raise NotImplementedError
+
+    @classmethod


When you implement this, it should probably be a static method, or even a function outside of the class.

jayvdb · 2018-06-12T10:41:08Z

cEP-0017.md

+REQUIREMENTS = {
+        DistributionRequirement(
+            apt_get='astyle',
+            dnf='astyle'


trailing ,

jayvdb · 2018-06-12T10:42:21Z

ack ca27c58

jayvdb · 2018-06-12T10:42:28Z

@gitmate-bot ff

gitmate-bot · 2018-06-12T10:42:30Z

Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently ⚠️

gitmate-bot · 2018-06-12T10:43:17Z

Automated fastforward with GitMate.io was successful! 🎉

xferra · 2018-06-13T10:24:39Z

cEP-0017.md

+                          Ubuntu, CentOS, Fedora, Arch Linux, openSUSE/SUSE,
+                          Gentoo Linux, Darwin
+        :param package: A string with the name of the package to be installed.
+        :param version: Version string. Leave empty to specify latest version.


I would like to recommend that tested version could be specified here as well; so, the end user may install the latest version or the latest version which was tested or any custom version.

Yup, it's too late as far as PR is merged, just FYI @jayvdb @anctartica

gitmate-bot added process/pending review size/XS difficulty/newcomer labels May 5, 2018

gitmate-bot reviewed May 5, 2018

View reviewed changes

saksham189 force-pushed the mycep branch from 904f4e2 to eea059d Compare May 5, 2018 14:46

jayvdb requested changes May 7, 2018

View reviewed changes

jayvdb reviewed May 7, 2018

View reviewed changes

jayvdb added process/wip and removed process/pending review labels May 7, 2018

jayvdb requested changes May 9, 2018

View reviewed changes

gitmate-bot added duplicate and removed difficulty/newcomer duplicate labels May 9, 2018

jayvdb requested review from Udayan12167 and xferra May 10, 2018 13:04

ishanSrt reviewed May 10, 2018

View reviewed changes

xferra reviewed May 11, 2018

View reviewed changes

xferra mentioned this pull request May 11, 2018

cEP 23: Breaking down coala #140

Open

pareksha suggested changes Jun 1, 2018

View reviewed changes

virresh reviewed Jun 6, 2018

View reviewed changes

saksham189 force-pushed the mycep branch from 559ca16 to d4adc28 Compare June 7, 2018 04:24

jayvdb requested changes Jun 7, 2018

View reviewed changes

jayvdb added process/wip and removed process/pending review labels Jun 7, 2018

gitmate-bot added the status/STALE label Jun 8, 2018

saksham189 force-pushed the mycep branch from d4adc28 to 10846ec Compare June 9, 2018 14:20

gitmate-bot added process/pending review and removed process/wip status/STALE labels Jun 9, 2018

saksham189 force-pushed the mycep branch from 10846ec to 6a702be Compare June 9, 2018 14:53

jayvdb reviewed Jun 12, 2018

View reviewed changes

jayvdb requested changes Jun 12, 2018

View reviewed changes

jayvdb added process/wip and removed process/pending review labels Jun 12, 2018

cEP-0017.md: Add cEP for cib

ca27c58

Closes coala#10

saksham189 force-pushed the mycep branch from 6a702be to ca27c58 Compare June 12, 2018 10:33

gitmate-bot added process/pending review and removed process/wip labels Jun 12, 2018

jayvdb approved these changes Jun 12, 2018

View reviewed changes

gitmate-bot added process/approved and removed process/pending review labels Jun 12, 2018

gitmate-bot merged commit ca27c58 into coala:master Jun 12, 2018

xferra reviewed Jun 13, 2018

View reviewed changes


		# Abstract

		This cEP describes the design of the cib tool which will allow it to install


		Here is the procedure for the installation of the bears:

		1. Identify the valid bear names that need to be installed as specified by the


		## Introduction

		The current design of the cib tool allows it to perform basic operations such as


		REQUIREMENTS = {}

		def __init__(self, platform: str, package: str, version="", repo=""):


		### Splitting `DistributionRequirement`

		```


		### Package Requirement

		```

cEP-0017.md: cEP describing design of cib #117

cEP-0017.md: cEP describing design of cib #117

Conversation

saksham189 commented May 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jayvdb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jayvdb commented May 7, 2018

jayvdb left a comment

Choose a reason for hiding this comment

ishanSrt left a comment

Choose a reason for hiding this comment

xferra commented May 11, 2018 • edited Loading

xferra left a comment

Choose a reason for hiding this comment

saksham189 commented May 11, 2018 • edited Loading

saksham189 commented May 30, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saksham189 Jun 9, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saksham189 Jun 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jayvdb commented Jun 12, 2018

jayvdb commented Jun 12, 2018

gitmate-bot commented Jun 12, 2018

gitmate-bot commented Jun 12, 2018

xferra Jun 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saksham189 commented May 5, 2018 •

edited

Loading

xferra commented May 11, 2018 •

edited

Loading

saksham189 commented May 11, 2018 •

edited

Loading

saksham189 Jun 9, 2018 •

edited

Loading

saksham189 Jun 12, 2018 •

edited

Loading

xferra Jun 13, 2018 •

edited

Loading