electric-cloud / ec-chef

ElectricFlow integration for Chef

electric-cloud

Open Source landing page

ec-chef's Issues

Update help file for 'all node features'

The help page should have documentation for the new procedures that have been added.
Please also update the Release Notes section

In the PR please cc @jkchew . She will likely have suggestions.

/cc @jkchew

Upload single/multiple cookbooks to Chef Server

User should be able to upload new cookbook(s) to a chef server using the plugin

Do not emit --ssh-password in step log file for Bootstrap procedure

We should not emit the password in the step log file. Can we write a file and put the password inside?

If there is no other way but to pass the password on the command line then we should either not emit the command line or hide the password ([PROTECTED] or '**'')

List data bags

EditRole Procedure needs adjustment in terms of knife commands called and job step output

Steps to reproduce

1. Create a role 'test-role1' as follows

{
  "name": "test-role1",
  "description": "foo",
  "json_class": "Chef::Role",
  "default_attributes": {

  },
  "override_attributes": {

  },
  "chef_type": "role",
  "run_list": [

  ],
  "env_run_lists": {

  }
}

2. Run the EditRole procedure, change the 'description' in the json above to something like 'foo2'.
   

3. Run procedure

EXPECTED -
Role is edited and job step log reinforces that impression

ACTUAL -
Role is first deleted and then created. Job step output says 'Success: No changes applied' but the description was changed.

Side note: Do we need to issue the delete? From chef documentation it looks like we only need to issue knife role from file FILE

EditNodeDriver performs platform specific operations

See PR. Comment copied from PR

This is not platform independent and will not work on Windows. Can you instead write to current working directory (which is typically the scoped to the job)?

I would recommend taking a look at http://perldoc.perl.org/File/Temp.html . It's a good idea to always add a bit of randomness to the file name to support parallel execution. See examples in perldoc. We've used File::Temp and this pattern in other plugins.

Test for Bootstrap procedure should have a configurable user name and password

Right now it looks like the user and password are hardcoded to 'username' and 'password'. My machine does not have this user or password so the test does not pass.

List available cookbooks

Show Cookbook contents

Show data bag contents

Dockerfile for CI procedure

We use Docker for CI tests (server-side deployments) and CentOS 6.4 for machines running EF Agents.
So, to setup CI tests for this plugin, we need Dockerfile for server, and instructions for setting up client on Agent machine (CentOS 6.4).

Change parameter type for ssh_password parameter in Bootstrap

Use credential parameter instead. We should never ask for a password and store it in clear text.

For the procedure 'Bootstrap' in EC-Chef, the parameter 'ssh_password' is currently 'entry'. 'ssh_password' and 'ssh_user' can be combined into a credential parameter.

This is a blocker and the plugin cannot be shipped unless this is addressed.

Edit existing data bag

The way i see it, you can replace the existing databag with updated contents

Add README instructions on how to run tests

Now that we have tests can we get a little bit of a write up on how to run them?

They should be geared towards new contributors. What are the pre-reqs: what sofware needs to be installed, what files need to be created/ what information from the chef server do we need?

After writing them please use a fresh vagrant box and try out the instructions as that is ultimately what I will do (aka Acceptance criteria).

Remove use of perl global variables in new code

We should not be adding additional global variables

For the files that you've created/recently added please avoid global variables

To reproduce:
Run find . -name "*.pl" | xargs fgrep -l "$::"

find . -name "*.pl" | xargs fgrep -l "$::"
./src/main/resources/project/drivers/AddRecipesToNodeRunListDriver.pl
./src/main/resources/project/drivers/CreateNodeDriver.pl
./src/main/resources/project/drivers/DeleteSingleNodeDriver.pl
./src/main/resources/project/drivers/DownloadCookbookFromRepositoryDriver.pl
./src/main/resources/project/drivers/EditNodeDriver.pl
./src/main/resources/project/drivers/InstallCookbookOnClientDriver.pl
./src/main/resources/project/drivers/ListNodeDriver.pl
./src/main/resources/project/drivers/RemoveRecipesFromNodeRunListDriver.pl
./src/main/resources/project/drivers/RunChefClientDriver.pl
./src/main/resources/project/drivers/ShowNodeDriver.pl
./src/main/resources/project/drivers/UploadCookbooksToServerDriver.pl
./src/main/resources/project/postp_matchers.pl

Ideally this find + fgrep command would return no results. But this issue to keep track of the global vars being introduced into the new features

ListRole Procedure should be plural "ListRoles"

There is a discrepancy between what we write in the job output and the name of the name of the procedure.

Seeing as we are listing all roles, I vote for changing the procedure name to "ListRoles"

Error handling for 'all node features'

As brought up in this #11 .

• Please check exit codes when invoking system commands
• Please toggle $ec->abortOnError

Bootstrap windows and linux node from a workstation

README needs to be updated with prerequisites for running tests

Will update this description as I find out more.

• Had to install ChefDK
• Had to write validator.pem and chef server url in knife.rb.

Acceptance criteria-

After reading the README a user should be able to successfully run all tests on a fresh linux box (after following the instructions).

Unit tests and integration tests distinction

With gradle plugin, we have three tasks for tests, one for integration tests (systemtest) and two others for unit testing of perl and java (GWT) code (unittest & test).

Solely purpose of unit tests is to make them run as fast as possible, and independent from working environment (Flow Server & Agent).

For integration testing (which use EF & Agent), we have separate tests, which are based on ntest framework, and which we are actively using in our CI procedures.

I've made modifications to support java-based system tests in or new CI system, but please, note, that system tests is more preferred way for us to do integration testing. So, in future, please, use ntest framework. Ask me, if you have any questions on how to setup CI tests with ntest.