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.

Sign up for GitHub

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

Jump to bottom

Create plugin script #1302

Merged

oxarbitrage merged 7 commits into bitshares:develop from oxarbitrage:template_plugin

Sep 28, 2018

+254 −0

Member

oxarbitrage commented Sep 2, 2018

When working with plugins the developer find himself doing the same renaming work too many times.

I found a script in eos that actually do the job of automating plugin creation: https://github.com/EOSIO/eos/blob/master/plugins/eosio-make_new_plugin.sh

So i copied over and added some further instructions to get up and running in bitshares after the files are all in place.

The template is a plugin with implementation class, most of our plugins are like that even if there are others that don't follow this pattern i think this is the way most of them can be built.

It haves some minimal functionality on how to add an argument and an onBlock function that will execute every block.

For further examples the developer will check other plugins, unfortunately we have no plugin that exposes api calls in the plugin itself. This is only visible on @xeroc hello plugin:

https://github.com/bitshares/bitshares-core/tree/hello_plugin/libraries/plugins

I think we should encourage the use of the api in the plugin itself rather than adding to api.cpp but i didn't added this to template as most plugins will not want it, tried to keep it simple.

Sample script output:

alfredo@alfredo-Inspiron-5559 ~/CLionProjects/template_plugin/libraries/plugins $ ./make_new_plugin.sh stoploss
Copying template...
Renaming files/directories...
Renaming in files...
Done! stoploss is ready.
Next steps:
1- Add 'add_subdirectory( stoploss )' to CmakeLists.txt in this directory.
2- Add 'graphene_stoploss' to ../../programs/witness_node/CMakeLists.txt with the other plugins.
3- Include plugin header file '#include <graphene/stoploss/stoploss.hpp>' to ../../programs/witness_node/main.cpp.
4- Initialize plugin with the others with 'auto stoploss_plug = node->register_plugin<stoploss::stoploss>();' in ../../programs/witness_node/main.cpp
5- cmake and make
5- Start plugin with './../programs/witness_node/witness_node --plugins "stoploss"'. After the seed nodes are added you start to see see a msgs from the plugin 'onBlock' 
alfredo@alfredo-Inspiron-5559 ~/CLionProjects/template_plugin/libraries/plugins $

oxarbitrage added 2 commits

September 2, 2018 19:46


          add make_new_plugin script

a7f14c2


          fix duplicated step

066b676

oxarbitrage changed the title ~~Create template script~~ Create plugin script

Member

clockworkgr commented Sep 3, 2018

Nice!


          remove space id section

aa87cd2

ryanRfox added this to the 201810 - Non-Consensus-Changing Release milestone

Contributor

pmconrad commented Sep 5, 2018

It would be nice to have the script look up used database space ID from other plugins and automatically select a new one.

abitmore modified the milestones: 201810 - Feature Release, 201812 - Feature Release


          added automatic space_id detection

64505a8

Member Author

oxarbitrage commented Sep 27, 2018

I am not very good at bash but created a function in script to detect biggest space_id and sum 1 to it. This number will be used in the template being created. This is at 64505a8

pmconrad suggested changes

View reviewed changes

libraries/plugins/make_new_plugin.sh Outdated

+                  for i in * ; do
+                      if [ -d "$i" ] && [ "$i" != "CMakeFiles" ]; then
+                          cd "$i/include/graphene/$i"
+                          result=$(grep -rnw '.' -e '#define [[:alnum:]]*_SPACE_ID')

Contributor

pmconrad Sep 27, 2018

Should use [[:space]]* after #define instead of single space

libraries/plugins/make_new_plugin.sh Outdated

               for file in `find $pluginName -type f -name '*template_plugin*'`; do mv $file `sed s/template_plugin/$pluginName/g <<< $file`; done;
               echo Renaming in files...
               find $pluginName -type f -exec sed -i "s/template_plugin/$pluginName/g" {} \;
+              echo Assigning next available SPACE_ID...
+              next_space_id
+              find $pluginName -type f -exec sed -i "s/0000/$?/g" {} \;

Contributor

pmconrad Sep 27, 2018

Better use something that's recognizable as a placeholder, like @SPACE_ID@, not a valid integer number.

libraries/plugins/make_new_plugin.sh Outdated

+                  exit 1
+              fi
+              pluginName=$1

Contributor

pmconrad Sep 27, 2018

Put double quotes around all strings where variables are expanded.


          make review changes

2e4edf9

pmconrad reviewed

View reviewed changes

libraries/plugins/make_new_plugin.sh Outdated

-              echo Copying template...
+              echo "Copying template..."
               cp -r template_plugin $pluginName

Contributor

pmconrad Sep 27, 2018

Please quote $pluginName here and in the following lines.


          quote more pluginName

3dfa5ac

pmconrad reviewed

View reviewed changes

libraries/plugins/make_new_plugin.sh Outdated

+              echo "Renaming files/directories..."
+              mv "$pluginName/include/graphene/template_plugin" "$pluginName/include/graphene/$pluginName"
+              for file in `find "$pluginName" -type f -name '*template_plugin*'`; do mv $file `sed s/template_plugin/"$pluginName"/g <<< $file`; done;

Contributor

pmconrad Sep 28, 2018

Please quote $file

pmconrad reviewed

View reviewed changes

libraries/plugins/make_new_plugin.sh Outdated

+              mv "$pluginName/include/graphene/template_plugin" "$pluginName/include/graphene/$pluginName"
+              for file in `find "$pluginName" -type f -name '*template_plugin*'`; do mv $file `sed s/template_plugin/"$pluginName"/g <<< $file`; done;
+              echo "Renaming in files..."
+              find $pluginName -type f -exec sed -i "s/template_plugin/$pluginName/g" {} \;

Contributor

pmconrad Sep 28, 2018

Please quote $pluginName

pmconrad reviewed

View reviewed changes

libraries/plugins/make_new_plugin.sh Outdated

+              find $pluginName -type f -exec sed -i "s/template_plugin/$pluginName/g" {} \;
+              echo "Assigning next available SPACE_ID..."
+              next_space_id
+              find $pluginName -type f -exec sed -i "s/@SPACE_ID@/$?/g" {} \;

Contributor

pmconrad Sep 28, 2018

Please quote $pluginName


          add more double quotes

59728cb

pmconrad approved these changes

View reviewed changes

Contributor

pmconrad commented Sep 28, 2018

Excellent, tested successfully. Some of the "next steps" could also be automated, but I think it might be better to leave these as manual steps.
Thanks!

oxarbitrage modified the milestones: 201812 - Feature Release, 201810 - Feature Release

oxarbitrage merged commit 90ae25d into bitshares:develop

Member Author

oxarbitrage commented Sep 28, 2018

thanks @pmconrad :)

TheTaconator mentioned this pull request

Release Notes for BitShares Core 201810 #1381

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet