You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@tinkerpop.apache.org by FlorianHockmann <gi...@git.apache.org> on 2017/04/09 16:38:42 UTC

[GitHub] tinkerpop pull request #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-D...

GitHub user FlorianHockmann opened a pull request:

    https://github.com/apache/tinkerpop/pull/600

    TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

    https://issues.apache.org/jira/browse/TINKERPOP-1552
    
    Organization of the C# project:
    - `Gremlin.CSharp` is the C# GLV, it is nearly completely auto generated (except for the `Graph` class)
    - `Gremlin.Net`: Contains the driver that is basically an extension of the [existing Gremlin.Net driver](https://github.com/FlorianHockmann/Gremlin.Net) and the structure API, including GraphSON writers and readers.
    - `Gremlin.Net.Process`: Driver independent implementation + interfaces of common functionality for .NET GLVs. Allows Gremlin-CSharp to be used together with another driver.
    
    So this organization makes it possible to use Gremlin-CSharp together with another driver and it also allows to reuse a big part of the functionality for another .NET GLV.
    
    One design decision I took: The method names comply with .NET conventions and therefore use pascal case, so `g.V().has('name','marko').next()` becomes `g.V().Has('name','marko').Next()`. This should make it feel very natural for any C# programmer to work with Gremlin-CSharp. An added benefit is that it avoids reversed keywords in C# like `in` or `as` that would require a special treatment otherwise.
    
    In general, Gremlin-CSharp is very close to Gremlin-Python. This also means that it is not type-safe, all steps simply expect a `params object[]`. It was very easy to generate Gremlin-CSharp this way but this should be improved in the future.
    
    In order to support building everything from Maven, I decided to use a Maven plugin that allows building of .NET Core projects: https://github.com/kaspersorensen/dotnet-maven-plugin
    This made it relatively simple to integrate the .NET projects into the regular build process.
    
    The documentation is hugely borrowed from that of Gremlin-Python. However, I couldn't really test the generation of the documentation as I already got errors with an unmodified version using the docker image. So it would be nice if someone could check whether the documentation is generated correctly with my changes.
    
    When you want to try out Gremlin-CSharp: You can build it on most modern operating systems, you only need a recent version of the [.NET Core SDK](https://www.microsoft.com/net/core). Alternatively, you can also use docker. I added the necessary steps to install .NET Core to the `Dockerfile`.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/FlorianHockmann/tinkerpop TINKERPOP-1552

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/tinkerpop/pull/600.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #600
    
----
commit 63410fed9ce642542bc4e0c10966989bacac2a30
Author: Florian Hockmann <fh...@florian-hockmann.de>
Date:   2017-04-06T17:02:23Z

    Add Gremlin-CSharp and Gremlin-DotNet
    
    This adds Gremlin-CSharp (a C# GLV), together with a .NET driver. The
    driver is based on Gremlin.Net
    (https://github.com/FlorianHockmann/Gremlin.Net) with added support for
    GLVs and Gremlin-CSharp is auto generated, very similar to
    Gremlin-Python.
    This should fix TINKERPOP-1552.

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by spmallette <gi...@git.apache.org>.

Github user spmallette commented on the issue:

    https://github.com/apache/tinkerpop/pull/600
  
    > Do you want to figure out the test framework before merging in new GLVs or can we merge it in and then adopt the framework later on? 
    
    My inclination is to not be too hasty - note that the JS glv has been sitting for a while at #450 - and to use this opportunity to figure out what we need to do to properly bring both of these in.  One thing that may happen is that we merge both the PRs to a feature branch of this repo that TinkerPop can maintain/rebase/etc. You (and others) could in turn submit PRs against that until it's ready to merge to the release branches. This approach has the advantage that we can rig up the platform independent test suite around the existing project and the new GLVs.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by spmallette <gi...@git.apache.org>.

Github user spmallette commented on the issue:

    https://github.com/apache/tinkerpop/pull/600
  
    I suppose this answers it:
    
    https://github.com/NuGet/Home/issues/1891
    
    It sounds like they have the feature, but I don't completely follow it. Perhaps it will make sense to you and you could clarify.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by FlorianHockmann <gi...@git.apache.org>.

Github user FlorianHockmann commented on the issue:

    https://github.com/apache/tinkerpop/pull/600
  
    Thanks!
    
    What's your stance on publishing prerelease packages of the GLVs? That would allow users to test them out so we can get some early feedback and additionally graph vendors can use them to create their own packages with custom serializers for their types and to support their own predicates. But I can of course understand if you prefer to wait with that for the testing framework.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by spmallette <gi...@git.apache.org>.

Github user spmallette commented on the issue:

    https://github.com/apache/tinkerpop/pull/600
  
    does nuget have a SNAPSHOT system like java? i might not be opposed to SNAPSHOT release as we do that with java all the time and it comes with a certain kind of understanding that things will change (sometimes harshly). I'd be against other forms of "release".


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by FlorianHockmann <gi...@git.apache.org>.

Github user FlorianHockmann commented on the issue:

    https://github.com/apache/tinkerpop/pull/600
  
    No problem @spmallette, I followed the thread on the dev list and I think that it is a good intermediate solution to merge this (and other GLVs like Gremlin-JavaScript) to a separate TinkerPop branch. This would make it easier to collaborate on those GLVs and on the testing framework. It may then also be a good idea to publish prerelease versions of the GLVs to get first feedback by interested users.
    
    Regarding the testing framework itself: I never used Cucumber before but I played a bit with SpecFlow which is basically the .NET version of Cucumber and I think that it looks very promising for our use case of generating tests for the different languages based on common specifications. Unfortunately, SpecFlow [isn't yet ready for .NET Core](https://github.com/techtalk/SpecFlow/projects/2) but that shouldn't influence the decision on a testing framework for the GLVs as it is only an intermediate problem.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by FlorianHockmann <gi...@git.apache.org>.

Github user FlorianHockmann commented on the issue:

https://github.com/apache/tinkerpop/pull/600

I developed the C# project before in another repository and only used the development branch in the end to merge it into TinkerPop. That's why it seemed to go so quickly \U0001f604

Do you want to figure out the test framework before merging in new GLVs or can we merge it in and then adopt the framework later on? Maybe it's even an advantage to have a GLV ready that is completely independent of Java for developing the testing framework as it should be generally possible to use the framework with other languages when it works with a .NET based GLV.
I also tried to to reach a good code coverage, but a common testing framework for all GLVs would be really nice of course.

If you have any .NET related problems, don't hesitate to ask. But in general I think that it is much easier to work with .NET now thanks to .NET Core which allows to do basically everything from the command line like building and testing and it's OS-independent. [Rider](https://www.jetbrains.com/rider/) might also be interesting for you, especially when you work on Linux and are used to IntelliJ.

---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by FlorianHockmann <gi...@git.apache.org>.

Github user FlorianHockmann commented on the issue:

    https://github.com/apache/tinkerpop/pull/600
  
    I don't know how it works with Java, but NuGet uses semantic versioning and treats packages with a suffix as pre-release packages. So something like `3.2.5-prerelease1` or `3.2.5-beta01` would work. xUnit for example uses `alpha`, `beta` and `rc` followed by a build tag: https://www.nuget.org/packages/xunit
    It's only important to increment the suffix when something changed.
    (For more information, see: https://docs.microsoft.com/en-us/nuget/create-packages/prerelease-packages)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop issue #600: TINKERPOP-1552 Add Gremlin-CSharp and Gremlin-DotNet

Posted by spmallette <gi...@git.apache.org>.

Github user spmallette commented on the issue:

    https://github.com/apache/tinkerpop/pull/600
  
    @FlorianHockmann don't want you to think that this pr was forgotten. there didn't seem to be any objection to merging this pr to a local tinkerpop branch for further collaboration - so that much will likely happen in the more immediate term. longer term, i'm still thinking through options for the overall test framework and for serialization issues glvs are facing. there will be discussion on the dev list around that topic i think (though i i long ago brought up cucumber tests on the dev list as the approach for generalized testing and there were no other suggestions presented, so in a sense we have some consensus there on that avenue of thinking).


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---