Features (WIP). #345

tarik02 · 2019-05-16T21:08:53Z

An ability to pass parameters (features) to dependencies and to use them in BUCK configs. Features comes with condition system allowing to disable dependencies based on dependencies.

Description

Features can be set for each dependency. Here is an example:

[[dependency]]
package = "github.com/buckaroo-pm/glfw"
version = "branch=master"

  [[dependency.feature]]
  name = "profile"
  value = "core"

  [[dependency.feature]]
  name = "api"
  value = { gl = "3.2", gles = "" }

  [[dependency.feature]]
  name = "extensions"
  value = [
    "GL_EXT_framebuffer_multisample",
    "GL_EXT_texture_filter_anisotropic"
  ]

GLAD library itself has a generator script which can be called using gen_rule from BUCK. So, features will allow to configure the script.

Feature types

Current implementation will have these types:

boolean
integer
string
dict - associative container with string key and any value of plain types
list - list of any plain values

Conditions

Conditions are the way to disable some of dependencies based on passed features. Example:

[[dependency]]
package = "github.com/buckaroo-pm/host-pthread"
version = "branch=master"
condition = "use_threads"

condition field can be array, then the dependency will be enabled when at least one of conditions are true.

Condition text is python-like expression, but with very limited syntax.

Condition evaluation

If a feature used in condition is not specified, the condition will be false.
List of operators:

condition = "feature1" # for boolean features
condition = "feature >= 5" # for integers/versions
condition = "feature = 'abc'" # for previous ones/strings
condition = "feature contains 'something'" # for arrays (has value)/dicts (has key)
condition = "feature contains ['something', 'something']" # the same, but a few operands (all should satishfy the condition)
condition = "feature = 'abc > 5 and abc < 10'"
condition = "feature = 'abc > 5 or def > 10'"
condition = "feature = 'abc > 5 or (abc > 2 and def > 10)"

Also, there can be single not prefix which inverts the result of condition evaluation. Example:

condition = "not 'something' in feature"

Related Issue

Closes #344

Motivation and Context

It is very useful feature to pass some parameters to universal dependencies. This is very common in C++ code, especially in cross-platform libraries.

Useful links:

https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section

How Has This Been Tested?

Still WIP

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.

Progress:

Feature parsing.
Condition parsing.
Feature value passing.
Condition checking.

…ed with `buckaroo.lock.toml`

CLAassistant · 2019-05-16T21:09:03Z

All committers have signed the CLA.

njlr · 2019-05-17T11:05:53Z

From https://docs.bazel.build/versions/master/skylark/language.html:

The following basic types are supported: None, bool, dict, function, int, list, string. On top of that, two new types are specific to Bazel: depset and struct.

So the types of features must be limited to these. For example, no floats.

More info here: https://buck.build/files-and-dirs/buckconfig.html, section "Key values as lists"

Turn dict into list of k1 v1 k2 v2... instead of list of k1=v1 k2=v2

tarik02 · 2019-05-19T16:22:34Z

There is a problem with the way how to collect features from packages, e.g. if there is two packages containing the same dependency with different features. Also, there should be some way to collect features from all manifests.

nikhedonia · 2019-05-20T09:51:13Z

There is a problem with the way how to collect features from packages, e.g. if there is two packages containing the same dependency with different features

This is the nature of the beast. It is similar to conflicting version constraints.

Things to consider:

In the C/C++ world there are two kind of features: additive and exclusive features.
An example for additive features is -DWITH_GTK in OpenCV.
Other flags may be exclusive eg. -DWITH_RTTI may be exclusive as they may change the ABI.

If we encounter different feature requirements that are additive then we can merge the features.

If we encounter a different exclusive features we have a conflict.
In this case the user needs to intervene as there is no obvious way how to resolve this situation.
Ways the user can resolve this are:

make one of the packages that introduces that conflict private
create an explicit override that declares what feature to use.

The later one is not implemented in Buckaroo yet.
However we can override configurations in Buck quite easily using the buck build -c <cell>//feature=value syntax.
If we provide an option to ignore feature conflicts this conflict could be manually resolved by the user at build-time.

Whether we should allow this kind of practice is probably an important discussion to have...

0Grit · 2019-06-03T20:16:03Z

Is this something that should be handled in package management, or should it be done in build management?

tarik02 · 2019-07-16T15:38:30Z

Have no idea how to continue this PR. Sorry.

tarik02 added 2 commits May 16, 2019 22:51

Implemented features parsing

d3069d2

Warning when running buckaroo install with buckaroo.toml not sync…

d4d11e3

…ed with `buckaroo.lock.toml`

tarik02 added 2 commits May 17, 2019 15:27

Fix Buckconfig lists and tuples.

08468e6

More info here: https://buck.build/files-and-dirs/buckconfig.html, section "Key values as lists"

Remove floats. Add Escape module. Add renderIni to feature values.

b11990a

tarik02 force-pushed the features branch from 5fd5815 to b11990a Compare May 17, 2019 12:40

tarik02 added 5 commits May 17, 2019 15:50

Make dict parsing simpler from Skylark side

f0a96d6

Turn dict into list of k1 v1 k2 v2... instead of list of k1=v1 k2=v2

Implement basic feature passing

81ad20a

Add condition parsing (using FParsec)

b3274af

Fix condition parsing. Add parse function.

e65f742

Add conditions to manifest.

3da4703

tarik02 closed this Jul 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Features (WIP). #345

Features (WIP). #345

tarik02 commented May 16, 2019 •

edited

Loading

CLAassistant commented May 16, 2019 •

edited

Loading

njlr commented May 17, 2019

tarik02 commented May 19, 2019

nikhedonia commented May 20, 2019

0Grit commented Jun 3, 2019

tarik02 commented Jul 16, 2019

Features (WIP). #345

Features (WIP). #345

Conversation

tarik02 commented May 16, 2019 • edited Loading

Description

Feature types

Conditions

Condition evaluation

Related Issue

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Progress:

CLAassistant commented May 16, 2019 • edited Loading

njlr commented May 17, 2019

tarik02 commented May 19, 2019

nikhedonia commented May 20, 2019

0Grit commented Jun 3, 2019

tarik02 commented Jul 16, 2019

tarik02 commented May 16, 2019 •

edited

Loading

CLAassistant commented May 16, 2019 •

edited

Loading