Initiating Nautobot jobs, next-2.0 rebase

[MeganerdDev]

Closes: #223

224 closed in favor of this rebase

What's Changed

Adds the following nautobot subcommands:

• init_job() as init-job

  • Adds init_job subccomand which initiates a Nautobot job by job name
  • Update init_jobs for new pattern, tested and working
  • Adds kwargs JSON-string dictionary to init_jobs (untested but looks good)

• get_jobs() as get-jobs

  • Adds get_jobs which returns all Nautobot jobs viewable to user
  • Adds kwargs JSON-string list to get_jobs export header items (tested as working)

• filter_jobs() as filter-jobs

  • Adds filter_jobs which returns filtered set of Nautobot jobs viewable to user
  • eg: /nautobot filter-jobs "enabled" or /nautobot filter-jobs "enabled,installed"
    • this could be changed to JSON-string dictionary/list? eg: /nautobot filter-jobs '{"enabled": true}'

Remaining work

• [ ] The render markdown for init_job should presen thet job form items
  • [x] With init_job method we can pass kwargs as JSON-string (untested)
• [ ] Add to documentation

TODO

• [x] Explanation of Change(s)
• [x] Added change log fragment(s) (for more information see the documentation)
• [x] Attached Screenshots, Payload Example
• [ ] Unit, Integration Tests
• [ ] Documentation Updates (when adding/changing features)
• [x] Outline Remaining Work, Constraints from Design

Screenshots

/nautobot init-job

/nautobot init-jobs for job that is not enabled

if there is a failed job, we will return the job_result.result message

/nautobot get-jobs

by default we will get some head items

/nautobot get-jobs '["id", "name", "installed", "tags"]'

we can specify the header items we want with a JSON formatted list

if there is a bad key, eg: /nautobot get-jobs '["id", "name", "invalid key demo"]'

/nautobot filter-jobs "enabled"

Notes

• I was having some GIT troubles rebasing to next-2.0 the exact way I wanted, which is why I opened this PR. The other PR may serve use for any 1.x hold-overs by using the static service account?
• Thanks for the hard work on the user permission mapping @smk4664 , the feature looks solid

[MeganerdDev]

Got some edge cases left I think, but pretty much everything but making CI happy is left

[MeganerdDev]

I left a few TODO entries, but nothing is a blocker I think

[MeganerdDev]

Not sure if making pylint happy for generator is mandatory for merge or if we can add an ignore for this case # pylint: disable=use-a-generator

[MeganerdDev]

Thanks for the feedback, Ill get this updated!

[MeganerdDev]

My current action/to-do items for this PR:

• [x] have a job's user-input widgets prompt for chat user input
• [x] job to provide link to job (base url + path)
• [x] testing to confirm features working as expected
• [ ] documentation tasks

[MeganerdDev]

status update on TODO item -> "have a job's user-input widgets prompt for chat user input" I have a working concept, will update PR with that soon!

[MeganerdDev]

This now provides a separate nautobot subcommand init-job-form

When /nautobot init-job-form is called without a job name it presents a drop-down dialog Otherwise you can specify the job name, eg: /nautobot init-job-form "demo-job"

Caveats:

• Currently there is a blocking issues I am stuck on for this. Whenever I initiate the job it goes from Running then Pending status, although the job is actually running.
• init-job-form could be merged to a single subcommand with init-job, have the input form call itself with the additional args

[MeganerdDev]

I removed this helper function, noting in case we want to re-add (eg: enable_job subcommand would use this)

def enable_job(module, name, source="local"):
    """
    Helper function to look up a job by class and job model and enable it.

    Args:
        module (str): Job module name
        name (str): Job class name
        source (str): Job grouping (default: "local")
    """
    job_class = get_job(f"{module}.{name}")
    job_model = Job.objects.get(module_name=module, job_class_name=name) # .restrict() may be preferred if we pass user
    if not job_model.enabled:
        job_model.enabled = True
        job_model.validated_save()
    return 

[MeganerdDev]

Noting some things for the current status of this PR:

• I explored the idea of pagination of the job's drop-down item. It seemed to me that widget in each dispatcher already supported a large enough volume for these items
• Combining init_job and init_job_form subcommands? Not required for PR, but may be the better pattern
• Add an enable_job subcommand using the helper above? Not required for PR, can be its own PR
• Numeric input mask for numeric only text input widgets on client-side? Unexplored
• Some remaining TODO comments can be removed from the PR

Fixed items:

• The correct Job URL hyperlink is now properly presented to user in chat response
• The job is properly initiating, corrected by enqueue_job and refresh_from_db

[qduk]

Awesome work @MeganerdDev! The only thing I'd note is the addition of some documentation in the /nautobot commands table.