redhatinsights / approval-api Goto Github PK

View Code? Open in Web Editor NEW

1.0 7.0 20.0 6.75 MB

License: Apache License 2.0

Shell 1.20% Dockerfile 0.31% Ruby 91.23% Groovy 0.14% JavaScript 0.03% HTML 7.08%

hacktoberfest

approval-api's Introduction

OpenAPI for Rails 5

This is a project to provide OpenAPI support inside the Ruby on Rails framework.

Prerequisites

You need to install ruby >= 2.2.2 and run:

bundle install

Getting started

Environmental variables

export SERVICE_APPROVAL_DATABASE_USERNAME=<<database_user>>
export SERVICE_APPROVAL_DATABASE_PASSSWORD=<<database_password>>
or
export DATABASE_URL=postgres://pguser:pgpass@localhost/somedatabase
export MANAGEIQ_USER=admin
export MANAGEIQ_PASSWORD=smartvm
export MANAGEIQ_HOST=localhost
export MANAGEIQ_PORT=3000

bin/rake db:create db:migrate
bin/rails s

To list all your routes, use:

bin/rake routes

License

This project is available as open source under the terms of the Apache License 2.0.

approval-api's People

Contributors

Stargazers

Watchers

Forkers

hsong-rh bzwei mkanoor fryguy carbonin lgalis hyperkid123 gmcculloug eclarizio zsadeh syncrou abellotti bsquizz bdunne pkomanek wtwong316 chambridge dguhr

approval-api's Issues

Cache roles when validating multiple groups

Sample code to byebug inside Pod

Only for record, since #327 is closed and not allow to post comments:

require 'byebug'
request_id = 80
r = Request.find(request_id)
# add persona based on current user's role
req = {:headers => r.context['headers'].merge('x-rh-persona' => 'approval/admin'),
       :original_url => r.context['original_url']}
byebug
Insights::API::Common::Request.current = req
user = UserContext.new(Insights::API::Common::Request.current, {})
ActsAsTenant.with_tenant(Tenant.find_by(:external_tenant => Insights::API::Common::Request.current.tenant)) do
  r = Request.find(request_id)
  s = RequestPolicy::Scope.new(user, Request)

  start = Time.now.to_f
  s.resolve.to_a
  stop = Time.now.to_f
  puts "lapsed time: #{1000*(stop-start)}"
end

versioning should match other microservices

cc @bdunne @syncrou

422 Unprocessable entity when content is passed in as a hash

response_code=422 return_code=ok total_time=0.359236
[----] D, [2019-03-29T16:58:17.393012 #7538:3ff7049e5f6c] DEBUG -- : HTTP response body ~~BEGIN~~
{"message":"Validation failed: Content can't be blank"}

{"requester":"Fred Flintstone","name":"mongodb-persistent","content":{"product":"mongodb-persistent","portfolio":"Fred","order_id":17,"params":"{\"Name\":\"nginx-example-8fb026c5-dad9-4482-8aec-bd6feef660cc\",\"Namespace\":\"openshift\",\"Context Directory\":null,\"Memory Limit\":\"512Mi\",\"NGINX Version\":\"1.12\",\"Application Hostname\":null,\"GitHub Webhook Secret\":\"********\",\"Git Reference\":null,\"Git Repository URL\":\"https://github.com/sclorg/nginx-ex.git\",\"Generic Webhook Secret\":\"********\"}"}}

Replace checking roles from ACLS with latest RedHatInsights/insights-rbac#115

In #152, use RBAC API /api/v1/access/?type=role to query roles directly.

Need deployment scripts

cc @carbonin

request controller spec issues

describe 'GET /requests?decision=approved' test on object counting sporadically fails. Need to investigate.
describe 'POST /workflows/:workflow_id/requests' tests have exceptions in the background thread due to empty stages.

Possible sporadic failure

https://travis-ci.org/ManageIQ/approval-api/builds/457684560 shows a sporadic failure, but I cannot get it to fail locally no matter what I do.

From the spec, it is structured very strangely in that there is a top-level let for template_id, then a before block that uses the template_id, and then a context that sets a different template_id. I'm wondering if that override is happening in a different order, but I'm not sure.

Need a locking mechanism for actions

When a new action is created, we'd better to lock the request for accepting other actions. Because the api pod can be scaled up, we need to have a better locking mechanism.

Submit buttons not being render properly in mobile

Improve layout for mobile

x-rh-identity needs to be removed from openapi.json

The x-rh-identity defined in the openapi.json causes the generated client to step on the x-rh-identity and set it to nil which causes this error on the approval server

{"@timestamp":"2019-03-29T17:00:15.581740 ","hostname":"approval-api-42-5v95s","pid":17,"tid":"222a3ec","level":"crit","message":"K    eyError (x-rh-identity):"}

422 Unprocessable Entity when requester is missing

{"message":"Validation failed: Requester can't be blank, Content can't be blank"}

For this payload

{"@timestamp":"2019-03-29T17:39:47.002923 ","hostname":"approval-api-42-5v95s","pid":17,"tid":"222a48c","level":"info","message":"      Parameters: {\"name\"=\u003e\"mongodb-persistent\", \"content\"=\u003e{\"product\"=\u003e\"mongodb-persistent\", \"portfolio\"=\u0    03e\"Fred\", \"order_id\"=\u003e8, \"params\"=\u003e\"{\\\"Name\\\":\\\"nginx-example-c30e4a90-c793-47b9-8292-fb53e7c4b910\\\",\\\"    Namespace\\\":\\\"openshift\\\",\\\"Context Directory\\\":null,\\\"Memory Limit\\\":\\\"512Mi\\\",\\\"NGINX Version\\\":\\\"1.12\\\    ",\\\"Application Hostname\\\":null,\\\"GitHub Webhook Secret\\\":\\\"********\\\",\\\"Git Reference\\\":null,\\\"Git Repository UR    L\\\":\\\"https://github.com/sclorg/nginx-ex.git\\\",\\\"Generic Webhook Secret\\\":\\\"********\\\"}\"}, \"workflow_id\"=\u003e\"1    \"}"}

New Auto Approval thread doesn't have context

https://github.com/ManageIQ/approval-api/blob/e62a14340f6f144a8a97362d863852f8ff032b71/app/services/request_create_service.rb#L49

This code needs to change to have a context so that we can log the messages for the request with the context, the code needs to be modified to

def start_internal_approval_process(request)
   Thread.new do
     ManageIQ::API::Common::Request.with_request(request.context.transform_keys(&:to_sym)) do
       default_approve? ? default_approve(request) : auto_approve(request)
     end
   end
 end

Use a service class for group/user RBAC access

There should be a follow-up PR to address comments https://github.com/ManageIQ/approval-api/pull/51/files#r263940706