kitchen-hyperv icon indicating copy to clipboard operation
kitchen-hyperv copied to clipboard

Document how to setup a development environment on Windows, so starters can contribute

Open ebjornset opened this issue 7 years ago • 3 comments

I decided to try to make a minor change to test-kitchen/kitchen-hyperv to see if I could fix #62

When trying to test my code rake fails with the error "File does not exist:"

Here is a gist with the output from rake --trace

I've not been able to find any decription on how to setup my machine for development so here is what I did after some trial and error:

choco install ruby -y refreshenv gem install bundler bundle install rake build rake

From the Rake issue 247 it seems like I am facing an underlying gem load issue, but I have no clue as how to debug this further.

ebjornset avatar Jan 28 '18 16:01 ebjornset

I finally got my development environment working, by downgrading ruby to v 2.4.3.1.

Here is the steps I had to perform to get rake working:

choco uninstall ruby -y (I had v 2.5.0.1 installed) choco install ruby --version 2.4.3.1 -y refreshenv gem install bundler bundle install gem install minitest-stub-const gem install mocha rake

Maybe this should go somewhere, in the docs, so starters like me quickly can get up to speed?

ebjornset avatar Jan 29 '18 22:01 ebjornset

@ebjornset Ruby 2.5 is extremely new to the Ruby ecosystem (only released on Dec 25th) and most things aren't going to work as intended as the majority of the ecosystem is still updating.

That's a bit of a quirk of the Ruby ecosystem at the moment so it's not really something that bears documenting, at least in the readme - though a wiki page or dedicated DEVELOPMENT.md might be appropriate. Typically projects will have the Ruby versions pinned in the gemspec or you can see the supported Ruby versions via the CI files .travis.yml or appveyor.yml.

cheeseplus avatar Jan 29 '18 22:01 cheeseplus

@cheeseplus, thanks for the clarification. I would highly appreciate a wiki page or dedicated DEVELOPMENT.md. Currently I'm able to use rake and pester to work on my local code, but now the next barrier is to replace the bundled kitchen-hyperv driver inside test-kitchen with my local gem for verification. I must admit it feels like a steep learning curve at the moment.

ebjornset avatar Jan 30 '18 20:01 ebjornset