Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DataPublisher example agent #2962

Merged
merged 1 commit into from
Sep 29, 2022

Conversation

gwenkidd
Copy link
Contributor

@gwenkidd gwenkidd commented May 6, 2022

Description

Small updates to README.

Type of change

This change is a documentation update

How Has This Been Tested?

Ran a Listener agent with the DataPublisher agent and checked the volttron.log file to see that the data was being published to the message bus

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@gwenkidd gwenkidd requested a review from craig8 May 6, 2022 20:53
@gwenkidd gwenkidd changed the title small updates to README DataPublisher example agent May 6, 2022
@craig8 craig8 merged commit 531ada2 into VOLTTRON:develop Sep 29, 2022
craig8 pushed a commit that referenced this pull request Sep 29, 2022
craig8 added a commit that referenced this pull request Oct 3, 2022
* Disable abbrev on long options; add test

* add setup file to SCPAgent

* Fix exception order

* Remove RELEASE_NOTES.md

* added quick-start tutorial to documentation, under developing-volttron

* added quick-start tutorial to documentation, under developing-volttron

* Update to non-auth and modular auth for volttron.
Added dataclasses for parameters.
Moved and restructured code to break out rmq and zmq, and provide standardized APIs where applicable.

* Added 'vui' group to the generation of the web-users.json file in web/admin-endpoints.

* add readme to example C Agent

* added more details to the readme

* change readme file type to markdown

* fix headings

* remove extra parenthesis

* tested CSV agent and driver, and added to README

* updated the readme and added execute permission to the launch_my_historian.sh script

* merge

* add readme

* added readme with link to docs

* fix location of test_certs file in workflow for platform tests

* Added ZMQ/RMQ Client Authorization for Auth subsystem.
Updated terminology in main/config.
Updated allow auth to be True by default.
Cleaned up some imports.

* hot fix sphinx ref syntax error

* fix for #2901 #2864 (fix for rmq test cases with pika v1.2.0)
Work around for #2938

* hot fix CLI command error, sphinx syntax error

* Enabling rmq fixture for testing

* bug fix based on tests

* hot fix CLI command error, sphinx syntax error

* Updates to fix import issues.

* Added agent/config, which includes both agent/configs and agent/configs/filename endpoints and their test to vui_endpoints.

* Added agent/config, which includes both agent/configs and agent/configs/filename endpoints and their test to vui_endpoints.

* Merged Platforms Agents Configs endpoints in vui_endpoints.py. Minor fixes and added documentation for these endpoints.

* Fix for issue #2950. Handle unexpected exception in process loop

* fix for issue #2945

* Removed initial non-auth tests.
Added handling for allow_auth and AUTH_ENABLED to manage use of auth in config file.
Minor code cleanup.

* Added is_web_enabled, and is_auth_enabled to utils __all__.
Added AuthFileIndexError to auth __init__.py
Updated agent core to use is_auth_enabled.
Fixed mocked auth service to work with new auth service design.

* debugging mysql unit tests

* debugging mysql unit tests

* debugging mysql unit tests

* debugging mysql unit tests

* debugging mysql unit tests

* debugging mysql unit tests

* debugging mysql unit tests

* raised an error when config path doesnt exist

* Fixed import errors for tests.
Fixed connection issue to remote platforms.
Fixed rpc call names in web and web tests.

* created tests for load_config

* add readme for scheduler example agent

* add readme and small updates to agent.py file

* remove comment from python file and added it into a readme

* renamed config file and added in installation instructions to readme

* Fixed web to use appropriate auth methods.
Modified ZMQServerAuthentication and ZMQAuthorization to reference AuthService instance directly.

* updated readme to be more verbose and updated some comments in settings.py

* create readme using comment from python file, updated comments in settings.py

* Update README.md

* update readme

* updated readme based on PR comments

* updated readme

* add readme following similar structure to other stand alone example agents

* update readme

* update readme

* update numbering in readme

* created README and removed comments from config

* updated readme, and reverted changes to config

* change back to simpleweb

* get rid of the repetivie driver_type: fakedriver

* Update fake.config

remove comma to make json compliant

* add setup file, add readme, add certs verification to do_rpc function

* Added documentation for non-auth implementation, and modular approach to auth authentication and authorization.

* Updated pytests configuration to ignore contrib and unsupported files.
Updated openadr ven agent to ignore tests if dependencies aren't found.
Update actuator agent to ignore tests if local dependencies aren't found.
Increased default timeout to 300.

* delete WebRPC example agent, functionality will be moved over to jsonrpc endpoint of SimpleWebAgent

* Fixed missing external_platform argument in vui_endpoints.handle_platforms_agents_running._agent_running()

* Fixed accidental string conversion in vui_endpoints.handle_platforms_agents_enabled().

* Added checks for specific dependencies for MQTTHistorian.
Increased timeout for vc and platform driver install.
Added auth_enabled to PlatformWrapper.
Added Non-auth cases to volttron_instance and volttron_web_instance.

* Cleanup stop-volttron

* Update docs link

* small fix to BaseClientAuthorization's connect_remote_platform method.

* Minor ZMQAuthorization updates.

* Monkey patching in Control to fix gevent monkeypatching warning.

* Update requirements.py

Bump gevent to latest.

* Changed "route_options" to "links". Fixed behaviour of agents/vip_identity endpoint. Fixed tests.

* Delete IntervalValues.csv

Removed accidental addition to commit.

* Refactored connect_remote_platform into core.
Handled auth case in connect_remote_platform for zmq case.
 Cleaned up monkeypatch implementation for main, control_parser, and vip.

* Fixed rmq auth connection issues

* fixing merge conflict

* Pinned value for idna to fix issue with VC login authentication.

* Updated VC test to fail appropriately.
Modified is_running_in_container to handle subprocess error in call.

* Minor fixes to remote connection.

* WARNING: Test improvement to RMQ dependencies script. May remove before rc.

* minor fixes to rmq core platform connection

* Fixed RMQ connections.
Fixed web authentication page for RMQ.
Fixed CSR handling.

* Undid debug log messages

* Modified context to use TLSv1.

* Removed deprecated connect_remote_platform from auth subsystem.
Added grequests.
Updated connection_params for build_remote_connection_params.
Fixed url_address missing from RMQConnectionAPI.

* Remove duplicated code.

* Calling base class constructor

* fixed auth tests failing in non auth. Auth tests shouldn't run in non auth version

* Fixed typo

* Fix vc test using correct grequest api

* Fixes for forward historian connection between rmq and zmq instances

* Added toctree link to web-api documentation.

* Added toctree entries for web-api documentation.

* Removed upgrade option from bootstrap.py and made this the default.

* Remove updgrade option from bootstrap.py and make this behavior the default.

* federation/shovel fixes

* Use volttron-build-action v4 for rmq actions

* updated to using v4 of volttron-build-action

* Removed downstream tests for now.

* update version in the correct spot.

* Tests without connections shouldn't take volttron_instance.

* Update version/license and pinned requirements

* fix for issue #2945

* non auth fixes primarily for rmq

* moved code to deprecated

* moved code to deprecated

* reverting accidental commit

* reverting accidental commit

* Update driver tests; cleanup logs for security agent

* Fix for issue #2992

* fix for non auth

* commented out deprecated dbs for historian testing

* deleted test module that test only with the default config. agents that deal with database always need db details so agent won't work with default/empty configs

* Added fixture to skip for non auth case

* Added support for getting forecast data using station id. Issue number #2994

* removed crate and mongo historian from test param as we do not support those historians any more

* Added link to restful API from agent web framework. Renamed link from VUI to "Restful Web Interface".

* removed unused import - #2997

* Protect import statements when rabbitmq not installed

* Added link to restful API from agent web framework. Renamed link from VUI to "Restful Web Interface".

* Fix for issue #2999

* Fix for issue #2997

* Update volttron_platform_fixtures.py

Uncommented that was commented for debugging

* Increased sleep time in test_file_watcher to avoid timing issue with rmq.

* Add auth check

* Fix import statement

* skip rmq specific tests if pika is not available

* removed unused import

* test fixes

* Merge pull request #2882 from bonicim/feature/vctl-tag

Add --all-tagged option; add and fix vctl tests

* xfailed web tests as they are redundent.

* Cleanup commented out code

* Cleanup auth.py code add MagicMock to gitignore.

* Reformat code.

* Fix web test auth enabled is required for passing test.

* Fix rmq tests that weren't being run for web.

* RMQ web auth tests aren't valid.
Because the local agents are added on demand, so they need to be reworked.

* Fixed installation issue timeout with small buffer.

* param for fixture is passed through platform web instance.
xfail for rmq<-zmq web and zmq<-rmq web.

* param for fixture is passed through platform web instance.
xfail for rmq<-zmq web and zmq<-rmq web.

* Update README.md

Pinned helics pypi version to 2.8.0. 
Fixes Issue #3012

* skip rmq tests.

* 20 second wait is not required.

* Disabled webcsr tests for now.

* Fix spelling error.

* Fix spelling error.

* Refactor PlatformDriver test (#3013)

* Refactor PlatformDriver tests

* Reformat test to PEP 8 compliance

* Tests/fix test global settings (#3014)

* Refactor config store test fixture

* Reformat code to be PEP 8 compliant

* Tests/fix test device groups (#3016)

* Fix test_device_groups

* Reformat to PEP8 compliance

* Add logic to parse unsupported objects (#3021)

* 8.2 doc updates for non auth and left tree reorg (#3019)

* Updated Read the docs for non auth mode. moved docs around to reduce the length of left side nav tree

* Updated Read the docs for non auth mode. moved docs around to reduce the length of left side nav tree

* Update mongodb-related dependencies (#3005)

* hot-fix-doc/#3030There-are-two-menu-items-with-quickstart-to-two-different-locations (#3032)

* Remove unused import (#3017)

* Fix VOLTTRON_HOME substitution

* Remove unused import

Co-authored-by: Chandrika <schandrika@users.noreply.github.com>
Co-authored-by: Craig <3979063+craig8@users.noreply.github.com>

* Modify expected output (#3004)

* Modify expected output

* Update test

* Remove unused imports (#3018)

* Fix VOLTTRON_HOME substitution

* Remove unused imports

Co-authored-by: Chandrika <schandrika@users.noreply.github.com>
Co-authored-by: Craig <3979063+craig8@users.noreply.github.com>

* small updates to README (#2962)

* Update openadr docs (#3034)

* Renamed secure mode to agent isolation mode - fix for #3035 (#3036)

* fix for issue #3035

* renamed script used to stop agent running in isolation mode

* Update main copyright for rtd and fix formatting (#3033)

* Update vc list docs
Fix #3029

* Modify Copyright Date
Fix #3023

* Create CODE_OF_CONDUCT.md (#3040)

* Update issue templates (#3039)

* Update issue templates

* Update bug_report.md

Remove smartphone from bug template.
Add Volttron Version

* Minor fix for volttron-upgrade command (#3038)

* fix for issue #3035

* renamed script used to stop agent running in isolation mode

* Fix for issue #3037

* using pathlib.Path instead of os path

* #Updated 8.x upgrade doc about agent-isolation-mode - #3025 (#3042)

* #Updated 8.x upgrade document to include details about agent-isolation-mode. fixes #3025

* #Updated 8.x upgrade document to include details about agent-isolation-mode. fixes #3025

* Updated release history. fixes #3031 (#3043)

* More rtd updates. updated broken links, cleaned up left side tree (#3044)

Co-authored-by: Mark Bonicillo <mark.bonicillo@pnnl.gov>
Co-authored-by: gwenkidd <gwendolyn.kidd@pnnl.gov>
Co-authored-by: Cody Scott <cody.j.b.scott@gmail.com>
Co-authored-by: Kefei Mo <kefeimo@gmail.com>
Co-authored-by: gilb842 <spencer.gilbride@pnnl.gov>
Co-authored-by: David M. Raker <david.raker@utoledo.edu>
Co-authored-by: schandrika <chandrika@pnnl.gov>
Co-authored-by: Gokarna Jung Bhandari <gokarna.jung.bhandari@gmail.com>
Co-authored-by: Chandrika <schandrika@users.noreply.github.com>
Co-authored-by: Shwetha Niddodi <shwetha.niddodi@pnnl.gov>
Co-authored-by: sgilbride <49735262+sgilbride@users.noreply.github.com>
Co-authored-by: David M. Raker <david.raker@pnnl.gov>
Co-authored-by: Gwen Kidd <95827084+gwenkidd@users.noreply.github.com>
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants