Skip to content
Snippets Groups Projects

Bootstrapping RHGitaly

Merged Georges Racinet requested to merge topic/default/rhgitaly-tonic into branch/default
  1. Apr 02, 2023
    • Georges Racinet's avatar
      CI/CD: Rust lints (rustfmt, clippy and line widths) · f4e5c429582d
      Georges Racinet authored
      As we don't want to resort ot unstable features of rustfmt, we
      wrote a simple checker in Python.
      
      Also we have to run after the tests, because
      we need the protocol source files (e.g., `gitaly.rs` to be present).
      Without them, `cargo fmt` fails at the `use` statement.
      f4e5c429582d
    • Georges Racinet's avatar
      RHGitaly: fixed Clippy warnings · 555e544f7244
      Georges Racinet authored
      Some warnings have been fixed lower in the stack. However, the
      Camel Case rule for acronyms hurts my eyes in the case of TCP
      (and leads to plain wrong output when it ends up in startup logs
      through `fmt::Debug`).
      
      We had to change the way the generated code is included. This also
      has the nice effect of ignoring `gitaly.rs` in `rustfmt`, thus making
      `cargo fmt --check` work for us.
      
      The missing `Eq` impl when deriving `PartialEq` is new in Rust 1.63
      555e544f7244
  2. Mar 26, 2023
  3. Mar 23, 2023
    • Georges Racinet's avatar
      RHGitaly Comparison tests: comparison with HGitaly for ServerInfo · c7d863a582d1
      Georges Racinet authored
      We're defining a new fixture and `RpcHelper` for such comparisons.
      As expected, this is  much simpler than the one for Gitaly Comparison
      tests.
      
      The included test is actually useful: we are sure that we don't
      have version skew between RHGitaly and HGitaly. Given how it is
      implemented, this is not a surprise, but it'll have our back in
      case the implementation has to change.
      c7d863a582d1
    • Georges Racinet's avatar
      Comparison tests: cut off BaseRpcHelper from RpcHelper · 42fb2ee5dc24
      Georges Racinet authored
      This new base class does not carry the specificities of
      the Gitaly comparison, but still has feature flags, default args,
      and calling primitives. It will be useful to introduce Comparison
      tests between HGitaly and RHGitaly with room for growth.
      42fb2ee5dc24
    • Georges Racinet's avatar
      RHGitaly: proper version information · bd9e9d777e70
      Georges Racinet authored
      It was nice to use the purely stateless `ServerInfo` gRPC method
      (at least with the info that HGitaly provides) as a first example
      of an implementation using Tonic. Now it's time to provide the
      actual information, consistent with the Python implementation.
      
      We're using the `build_const` crate to inject the value at build time.
      This is actually importing from the `constants.rs` file in the
      relevant  build `out/` directory.
      
      Also the `..Default::default()` syntax (taught us by clippy) allows
      to avoid starting from the defaults to mutate a few fields.
      bd9e9d777e70
    • Georges Racinet's avatar
      CI/CD RHGitaly: using artifacts and cache · 9be2e5b333c4
      Georges Racinet authored
      This artifacts built by `tests-rust` will serve as precompilation
      for gitaly-comparison.
      
      For the cache, we follow the instructions of
      https://doc.rust-lang.org/nightly/cargo/guide/cargo-home.html#caching-the-cargo-home-in-ci
      but still exclude installed binaries information
      
      Hopefully, this will speed up the build a bit.
      9be2e5b333c4
    • Georges Racinet's avatar
      CI/CD: running pure Rust tests · 862e93be83cd
      Georges Racinet authored
      A simple `cargo test`.
      
      Because of the dependencies, we had to provide a new base image
      for this (we could have used heptapod-gitaly, but it is unsatisfactory
      to rely on a huge image when much less is needed).
      862e93be83cd
  4. Mar 19, 2023
    • Georges Racinet's avatar
      RHGitaly: Gitaly comparison tests · 69cb7195481a
      Georges Racinet authored
      We chose to compare RHGitaly with Gitaly rather than with HGitaly
      because it's not impossible that we stop at some point maintaining
      some methods in the Python code (time will tell).
      
      It is likely that we'll end up implementing some of the HGitaly-specific
      methods in RHGitaly (e.g. reading phases, topics and whatnot). In that
      case we'll need comparison between HGitaly and RHGitaly, but that
      will be some much simpler (no correspondence of Git content) that we
      will provide it directly.
      
      This fully hooked in CI/CD. We had to anyway: otherwise the new test would
      not pass.
      
      Implementation details
      ----------------------
      
      We add the capability to start RHGitaly, with a simple `cargo run`.
      This is validated independently by `test_rhgitaly_server` (homologous
      to `test_gitaly_server`).
      
      The `GitalyComparison` class (of which the `gitaly_comparison` fixture
      is an instance) now gains an optional `rhgitaly_channel`, which is set
      and exposed in the new `gitaly_rhgitaly_comparison` fixture.
      
      Finally, using `rhgitaly_channel` rather than `hgitaly_channel` is
      left to the `RPCHelper` class, with its `hg_server` argument.
      Since it is instantiated from inside the tests, it is easy to
      pass `hg_server` down from a parametrization, reaching the end goal: the
      very same test is run for HGitaly and RHGitaly, compared in both
      cases with Gitaly. This is illustrated in the test for `RepositoryExists`.
      
      Two annoyances had to be taken care of:
      
      - we need to ignore the `rust/` directory in `run-all-tests` because
        it makes pytest collection crazy (hangs forever) due at least in part
        to Mercurial full source being present by default in `rust/dependencies`
      - Tonic seems to add trailing metadata that Gitaly does not. We had
        to remove them in `assert_compare_errors()`.
      
      CI/CD assumptions
      -----------------
      
      The base image `heptapod-gitaly` is now expected to provide
      - the Rust toolchain
      - a clone of Mercurial sources. It can be daily or weekly, we
        make a share and update it
      - `rust-protobuf`: could be trimmed, as we only need
        the protocol files and don't need to update them for each build
      69cb7195481a
  5. Mar 18, 2023
    • Georges Racinet's avatar
      RHGitaly: configurable listen URL (TCP or Unix Domain) · d6853d85276f
      Georges Racinet authored
      We keep on configuring through environment variables, in order to
      focus on the task at hand: stop hardoding a TCP address and
      support Unix Domain sockets. The latter are the natural choice
      for integration tests, such as the Gitaly Comparison tests,
      as they come with strong guarantees not to be already in use.
      d6853d85276f
  6. Mar 17, 2023
    • Georges Racinet's avatar
      RHGitaly RepositoryExists implementation · 775265f65dc7
      Georges Racinet authored
      Similarly to the Python implementation, this introduces a top level
      module to take care of logic that will be useful for several methods.
      
      These top-level modules don't know about actual method or services,
      but they handle protobuf messages, `Status` errors etc.
      
      Like the Python implementation, we support only one storage (named `default`)
      and configuration does its repositories root.
      775265f65dc7
  7. Mar 28, 2023
    • Georges Racinet's avatar
      RHGitaly: logging with the tracing crate · 1bd1f685dbf7
      Georges Racinet authored
      This removes the (blocking) `println!` in favour of the standard `tracing`
      crate, which is precisely meant for asynchronous code.
      
      For now, we're exclusively logging to `stdout`, at the `INFO` level.
      Configurability will appear later.
      The `DEBUG` level is very verbose, as it includes lots of events from
      the tonic/h2 etc lower layers. These will certainly be interesting, yet
      not at this stage of developpement.
      
      Quoting from current documentation:
      
        The #[instrument] attribute provides an easy way to add tracing spans to
        functions. A function annotated with #[instrument] will create and enter a
        span with that function’s name every time the function is called, with
        arguments to that function will be recorded as fields using `fmt::Debug`.
      
      Hence we don't need to include the passed `request` in the call to `info!`.
      This also raises the question of the laziness of formatting, something that
      we will have to check later.
      
      Finally, Tonic's `Request` wrapper does include all invocation metadata, which
      is great to have `correlation_id` but won't be acceptable when we implement
      authentication, as it will also probably have the related secrets. It could
      be a simple matter of using an appropriate subscriber. We'll see.
      1bd1f685dbf7
  8. Mar 17, 2023
    • Georges Racinet's avatar
      RHGitaly: first service method · 9c1dd8a0eed1
      Georges Racinet authored
      We implement the `ServerInfo` gRPC.
      
      This is still very much a PoC: hardcoded address, no config or any kind
      of shared state, no proper (async) logging and the `server_info` value
      is not even valid (yet helpful to distinguish with other attempts on the
      same workstation).
      
      It is a of course unfortunate for an example that the simplest service that
      we can implement is `ServerService`. This leads us to niceties such
      as `ServerServiceServer`. Compare to the HelloWorld tutorial where
      the service is called `Greeter` and leads to a `GreaterServer` module.
      
      We decided to provide the `server_server` factory function to keep
      imports from generated code out of `main.rs`. Subsequent ones will
      be clearer: `commit_server` etc.
      9c1dd8a0eed1
  9. Mar 18, 2023
  10. Mar 17, 2023
    • Georges Racinet's avatar
      RHGitaly: initialized Cargo workspace and crate · 61d9b987a4b2
      Georges Racinet authored
      The idea is that we'll maintain a full clone of the Mercurial
      sources as `rust/dependencies/mercurial`, and the symlink
      will take the `hg-core` crate and anchor it to the workspace for
      RHGitaly, instead of the one from Mercurial sources.
      
      Because of this, we need to exclude the `rust` directory in
      `run-all-tests`. Otherwise, it makes pytest collection go crazy
      and hang forever.
      
      Also, we're versioning `Cargo.lock` because `rhgitaly` is a binary crate.
      61d9b987a4b2
Loading