leopardslab / nodecloud Goto Github PK

Describe the solution you'd like

• Writing unit tests for the parsers

Additional information

• Mocha and Chai is recommended to write unit tests

Impact

• Node cloud code generator

Describe the solution you'd like

• Writing unit tests for the generators

Additional information

• Mocha and Chai is recommended to write unit tests

Impact

• Node cloud code generator

Describe the solution you'd like

• Write tests for the Aliyun generator, integrate the parser and transformer to verify E2E functioning

Impact

• updates the code generation module of NodeCloud.

Linked PR: #139

Expected Behavior

• The hosting docs GitHub workflow should push the documentation to gh-pages.

Actual Behavior

• The relevant workflow is failing

Possible Solution

Seems like the github secret is missing in the repo GITHUB_TOKEN: ${{ secrets.JSDoc_TOKEN }}. .JSDoc_TOKEN needs to be created in the project repository.

Describe the solution you'd like

• Automate the process of manually creating classes for services in the Node Cloud plugins
• Data needs to be extracted from the cloud provider SDKs and a parser needs to be used in this process
• After extracting data JavaScript classes can be automatically generated using a transformer

Impact

• A new component to the project which can automatically generate JavaScript classes

Expected Behavior

Shouldn't throw an error when a provider other than officially supported is used.

Welcome to NodeCloud with Hacktoberfest 2020!

Stay in the know: Get notified of updates by clicking the 👁‍🗨 watch button and save the repository for later reference by clicking the ⭐️ star button at the top right corner of this repo!

Some typo errors need to be fixed:

The readme file of the nodecloud-next branch contains some typo errors. To note some (typo error > correction),

• NodeCloud ☁️ is standard library > NodeCloud ☁️ is a standard library
• providers with less code changes > providers with fewer code changes
• open source > open-source
• community driven plugin > community-driven plugin,
• third party > third-party
• background knowlege on these > background knowledge on these
• This is where magic happens✨ > This is where the magic happens✨
• automactically > automatically
• immediatly > immediately

These need to be corrected and if you identify more typo errors while reading, fix them as well. Feel free to add a comment for further clarifications!

Additional information

• The project currently contains two main branches: master and nodecloud-next. This feature is required to the nodecloud-next branch. so make sure that you create the feature branch from nodecloud-next.

nodecloud-next: https://github.com/leopardslab/nodecloud/tree/nodecloud-next.

• Be sure to sign up at https://hacktoberfest.digitalocean.com so you can qualify to pick a limited edition t-shirt 👚 or plant a tree 🌳!

• See https://hacktoberfest.digitalocean.com for more details.

• Add a comment below if you are interested, will assign the task.

Impact

• Read me file

Knowledge required

• Version control systems (git)

Describe the solution you'd like

Writing unit test for transformer

Impact

NodeCloud Code generation tool

Service comparison should be updated as there might be many updates in services in different providers.

https://github.com/cloudlibz/nodecloud#-service-types

Take Codacy suggestions into account and make necessary changes to improve the code quality.

In nodecloud/lib/core/base-provider.js, we process the input of .nc.config.js like this

ncConfig.map(provider => {
        const module = provider.plugin;
        providersToLoad[provider.tag] = module(ncConfig.configPath);
});

But shouldn't it be

ncConfig.map(provider => {
        const module = provider.plugin;
        providersToLoad[provider.tag] = module(provider.configPath);
});

Because ncConfig is an array of providers. So ncConfig.configPath = undefined
That's why we map the providers and it should be provider.configPath and it works that way too. The path is passed to the plugins when we use the latter approach.

@Cheesetouched can you remove .DS_STORE file in /lib.

Hello everyone I am full-stack web developer in MERN and MEAN with a specialisation in Node Js. I also have knowledge of Docker,AWS and Azure I would like to contribute to Score Labs . I have been contributing to open source from past 2 yrs
I am aiming to contribute to Project No.10 - NodeCloud - Rackspace Provider - Services as I have all the prerequisites for the project. I would be highly grateful if I could get a start to contribute to Score labs

Describe the solution you'd like

• Writing unit tests for the transformers

Additional information

• Mocha and Chai is recommended to write unit tests

Impact

• Node cloud code generator

Describe the solution you'd like

• Creating the digital ocean plugin using the created DO automation tool
• Including it in the node cloud packages

Impact

NodeCloud package

Describe the solution you'd like

• Updating project ReadMe files with the Node Cloud 2.0 architecture

Additional information

• Add architecture diagrams to explain the code generation process

Impact

• ReadMe files

Describe the solution you'd like

• Write unit tests for the Aliyun parser

Impact

• updates the code generation module of NodeCloud.

Linked PR: #138

After moving all plugin tests to respective plugins.

Related: #13

Expected Behavior

• node cloud package should be successfully working on sub directories of a node cloud installed project where the .nc.config.js is configured in the project root.

Actual Behavior

• node cloud works fine on the files in the root directory of the project
• In sub directories throws an error Error: Cannot find module 'd:\node-cloud-demo\scripts\.nc.config'(A quick patch was to copy the .nc.config.js to the sub folder where I needed the package )

E.g. -
Node cloud working fine on root directory files

Node cloud crashing on sub directory files

Node cloud working fine on sub directory files after copying .nc.config.js to subdirectory

Steps to Reproduce the Problem

1. Install node-cloud
2. Require node-cloud in a sub directory of the project

Reason to the issue

• Node cloud uses process.cwd() to get the current working directory to configure the ncConfig const ncConfig = require(path.join(process.cwd(), ".nc.config"));, In a sub-directory the .nc.config won't be there in the current directory.

Project-demo
│   node_modules
│   .nc.config.js
│   package.json
│   package-lock.json
│   index.js -----------------------------  Node cloud works fine here

│
│
└─── scripts
    │   tester.js -------------------------- Node cloud throws an error here 

• Related stack overflow topic - https://stackoverflow.com/questions/10265798/determine-project-root-from-a-running-node-js-application

Specifications

• Version: 1.0.0-beta.1
• Platform: Windows
• Subsystem: run-time - node version 12

Tests need to be moved to the respective plugins.
Change to new getProviders API.

• nodecloud-gcp-plugin
• nodecloud-azure-plugin

Current documentation doesn't explain the vocabulary of NodeCloud in a convenient manner. New users should be able to use the services without going through extra hassle to find the matching services in cloud providers and NodeCloud APIs.

A documentation page can be created with the vocabulary of current set of APIs in NodeCloud matched with vocabulary of the cloud providers.

Expected Behavior

After Introducing the getProviders function the AWS ec2 example hasn't been updated. The KeyName parameter was missing in the params object of the create AWS EC2 instance example which is in read me .

const optionsProvider = {
  overrideProviders: false
};
const ncProviders = nodeCloud.getProviders(optionsProvider);
const ec2 = ncProviders.aws.compute(options);

Actual Behavior

const ncAWS = nodeCloud.getProvider("AWS", process.env.ncconf);
const ec2 = ncAWS.compute(options);

Expected Behavior

The Nodecloud base-provider.js needs to instantiate and require each and every provided plugin module via the getProvider method

After modifying the nodecloud base-provider.js module below. It works just fine

/**

Returns requested provider type

@param {Object} {provider - Type of provider - can be found here '/aws/provider'}
*/
getProviders(options) {
if (ncConfig === undefined) {
throw new Error(
"Provider config file not found. Please create a config file in project root."
);
}
let providersToLoad = {};

  if (options && options.hasOwnProperty("overrideProviders") ) {
    ncConfig.map(provider => {
      const module = provider.plugin;
        providersToLoad[provider.tag] = module(ncConfig.configPath);
      });
  } else {

    ncConfig.map(provider => {
    if (!validProviders.includes(provider.name)) {
      throw new Error("Provider not supported");
    }

  const module = require(provider.libName);
    providersToLoad[provider.tag] = new module(ncConfig.configPath);
  });
}

Actual Behavior

The current NodeCloud base-provider.js isn't compatible with NodeCLoud-Azure-Plugin, It throws error each and every time I try to start nodecloud-web

The below snippet of code is buggy and it throws error

/**

• Returns requested provider type
• @param {Object} {provider - Type of provider - can be found here '/aws/provider'}
  */
  getProviders(options) {
  if (ncConfig === undefined) {
  throw new Error(
  "Provider config file not found. Please create a config file in project root."
  );
  }

let providersToLoad = {};

if (option && options.hasOwnProperty("overrideProviders")) {
  ncConfig.map(provider => {
    const module = provider.plugin;
    providersToLoad[provider.tag] = module(provider.configPath);
  });
} else {
  ncConfig.map(provider => {
    if (!validProviders.includes(provider.name)) {
      throw new Error("Provider not supported");
    }

    const module = provider.plugin;
    providersToLoad[provider.tag] = module(provider.configPath);
  });
}

return providersToLoad;

}

A screenshot of existing code and error

Steps to Reproduce the Problem

Follow Nodecloud-web installation guide
https://github.com/cloudlibz/nodecloud-web

Specifications

• Version:
• Platform: Windows 10
• Subsystem: node v10.16.2

Expected Behavior

assert and done() is not defined which will through a TypeError: Cannot read property of undefined, assert should be defined and the done() function should be specified or called through a relevant instance.

Actual Behavior

dynamoDB.createItem(params).then((res) => {
  assert.equal(res.ConsumedCapacity.TableName, "Test");
  done();
});

Line number 21 & 22 in aws-dynamodb example

Describe the solution you'd like

• Configuring JSDoc and better-docs
• Update transformers to automatically add JSDoc comments

Describe the solution you'd like

• Using a monorepo architecture to store all the Node cloud plugins in one Github repository

Additional information

• Lerna is recommended to use to manage Node Cloud plugins.

Impact

• Overall application

References

• https://medium.com/@jsilvax/a-workflow-guide-for-lerna-with-yarn-workspaces-60f97481149d
• https://www.youtube.com/watch?v=ZSdCNf1ncOE&list=LLh83suuTLe5XvJS2qjzem8Q&index=4&t=0s
• https://www.youtube.com/watch?v=p6qoJ4apCjA&list=LLh83suuTLe5XvJS2qjzem8Q&index=5&t=0s
• https://medium.com/trabe/monorepo-setup-with-lerna-and-yarn-workspaces-5d747d7c0e91
• https://medium.com/naresh-bhatia/sharing-ui-components-with-lerna-and-yarn-workspaces-be1ebca06efe

Describe the solution you'd like

• Traversing through the Abstract Syntax Tree of the source code and collecting required data

Additional information

• Adding Functions, Identifiers, and Comments

Impact

NodeCloud code generator

More unit tests should be added to cover the core logic. i.e: /lib/core

Describe the solution you'd like

• Parsing the type definition files of the Aliyun V2 SDK

Additional Information

• Generate the annotated AST of the required methods from type definition files

Impact

• NodeCloud codegen module update, addition of a parser

Linked PR: #138

Expected Behavior

Lib should work

Actual Behavior

It fails to run

Steps to Reproduce the Problem

1. Run a sample following the documentation

Specifications

• Version:
• Platform:
• Subsystem:

Describe the solution you'd like

• Post service integration from the Aliyun plugin, add examples for service usage.

Impact

• Creates examples in the directory examples

Linked PR: #144

Describe the solution you'd like

• AST traversal to apply transformations to fill out the
  dummy classes
• Apply relevant transformations such as adding functions,
  parameters for the corresponding functions, and comments for
  the same in the auto-generated classes

Impact

• updates the code generation module of NodeCloud

Linked PR: #139

Describe the solution you'd like

• Write unit tests for the Aliyun transformer

Impact

• updates the code generation module of NodeCloud.

Linked PR: #139

Describe the solution you'd like

• Implement the generator by using parser and transformer implemented.
• Apply transformations of identifier addition, method param addition and comment addition.

Impact

• updates the NodeCloud code generation module.

Linked PR: #139

Describe the solution you'd like

• Update the Nodecloud yml file to include digital ocean services

Impact

• NodeCloud code generation tool

Describe the solution you'd like

• Parsing the type definition files of Digital Ocean SDK

Additional information

• To generate an Abstract Syntax Tree from definition files

Impact

NodeCloud code generator

Describe the solution you'd like

Writing unit tests for the parser

Impact

NodeCloud Code generation tool

Describe the solution you'd like

• Writing Generator using parser and transformer

Impact

NodeCloud code generator

Describe the solution you'd like

• After integrating new services of the AWS plugin write examples for them.

Impact

• Examples directory

Describe the solution you'd like

Addition of ESLint (as static code analyser) and prettier (to enforce code styles via a configuration file) .

Additional information

Currently, the code base does not employ any methods for standardising code quality and consistency across multiple contributors. This can be achieved via the addition of ESLint and prettier respectively. This will completely remove changes that do not pertain to changes in logic across PRs. This issue was apparent because my existing prettier config in vscode was in conflict with the existing code practices in NodeCloud and even a minor change went ahead and formatted the entire file, this will reduce the readability for project maintainers in pull requests.

Impact

Adds a default coding style and removes unnecessary changes in code in multiple PRs across multiple contributors. For example, switching between single and double quotes across multiple PRs in the same code segment. Additionally, the formatter used currently is pretty-quick with no configuration file present, because of this #109 is required, although this is not feasible as the number of contributors in the project increases and should be automated before a commit. Additionally, best practices should be enforced via the use ESLint which can be updated as required via a config file.

Attaching instances of apparent inconsistencies

References

• misconfiguration of the formatter
  In each commit, the pretty-quick script is run by husky, and this takes the default config of prettier set in the user's vscode, due to this an entire file gets formatted even when there is no major change in it, makes the process of reviewing changes difficult.

• conflicting single/double quote and trailing comma rules
  

• Additional conflicting linting rules with respect to imports, implicit any types and empty function definitions, all these are sources of potential bugs in future and can be avoided by using eslint and enforcing consistent practices.
  

Describe the solution you'd like

Writing Unit test for generator

Impact

NodeCloud code generation tool

Expected Behavior

FIX: #5
We Expected to see the successful working of npm start, after setting up an app with nodecloud module

Actual Behavior

Steps to Reproduce the Problem

1.Make a new nodeJS project by npm init
2. Inside your package.json, add nodecloud module "dependencies": { "nodecloud": "^0.1.0" }
3. Install dependencies bynpm install
4. Get a GCP key (link is given on the https://github.com/cloudlibz/nodecloud-gcp-plugin), download the key.json file and place it into your root folder.
4.In your server.js (or your mainjsfile.js), include nodecloud module by typing in:

const nodeCloud = require("nodecloud");
// AWS
const gcpProviders = nodeCloud.getProviders('google', 'dronesym-app-ceabf26a2a7e.json');
const options = {
  apiVersion: "2016-11-15"
};
console.log(gcpProvider);

5. Create a .nc.config.js file containing the code

const providers = [
    {
        name: 'google',
        tag: 'google',
        libName: 'nodecloud-gcp-plugin',
        configFile: {
            projectId: "<your project ID>", //most probably will be "dronesym-app"
            keyFilename: "<path to your GCP Key JSON file>"
//GCP gives you the download of a pre-built key JSON file
        }
    },
    // other providers might be included here
]

module.exports = providers; 

6. Run the code by going into the terminal, running node <yourfile>.js
7. Meet the error!

===x===

How we found this error?

Me and @TheLukaszNs were discussing nodecloud related stuff on the gitter channel, When we both noticed an error on the same time, the code was simple, it just had to console.log(getProvider);
But changing getProvider() to getProviders() (as mentioned in readme.MD) would stop our code execution giving the above error. I've provided a fix for this^

Describe the solution you'd like

• After integrating new services of the GCP plugin write examples for them.

Impact

• Examples directory

Describe the solution you'd like

• Update the generator config file that specifies the services to be parsed from the linked SDK to include services from the Aliyun V2 wrapper SDK.

Impact

• Updates the NodeCloud generator module interface

Linked PR: #141

Describe the solution you'd like

• Creating the Aliyun plugin using the created Aliyun generator
• Add Aliyun into the monorepo structure to automate builds and testing of the package with the entire project

Impact

• Creates the NodeCloud Aliyun plugin

Linked PR: #140 #141

Welcome to NodeCloud with Hacktoberfest 2020!

Stay in the know: Get notified of updates by clicking the 👁‍🗨 watch button and save the repository for later reference by clicking the ⭐️ star button at the top right corner of this repo!

Creating a prettier Github action

Prettier is a very popular code formatter to format your code and prevent the ongoing debates about code styles. Currently, prettier is triggered through a pre-commit hook (husky) which will run Prettier on the staged files prior to committing.

This works well in most cases, but there are certain cases where the code might not be formatted:

• Running git commit --no-verify will commit code without running pre-commit hooks which can result in files not being formatted.

• Pre-commit hook (husky) is not properly installed in the developers local machine.

To automate this process you can use git auto-commit action to run prettier and commit the changes if necessary. Check out the references to get started 🚀!

Additional information

• The project currently contains two main branches: master and nodecloud-next. This feature is required to the nodecloud-next branch. so make sure that you create the feature branch from nodecloud-next.

nodecloud-next: https://github.com/leopardslab/nodecloud/tree/nodecloud-next

• Be sure to sign up at https://hacktoberfest.digitalocean.com so you can qualify to pick a limited edition t-shirt 👚 or plant a tree 🌳!

• See https://hacktoberfest.digitalocean.com for more details

Impact

• Github workflows directory

References

• Helping article and sample project by @mskelton

• git auto-commit action by @stefanzweifel

The package version of nodecloud hasn't been updated since its creation - that makes some mess around documentation, as the code shown in documentation is newer than what we can use with NPM module!

Owner of this NPM package should bump the version to update the module 🔝

Describe the solution you'd like

• After integrating new services of the Azure plugin write examples for them.

Impact

• Examples directory

Describe the solution you'd like

• After integrating new services of the digital ocean plugin write examples for them.

Impact

• Examples directory

Tests should be updated to .getProviders() API.

eg: .getProviders().aws