Skip to content
This repository has been archived by the owner on Dec 3, 2021. It is now read-only.

New Lesson - Robot Framework #112

Closed
saimkhan92 opened this issue Oct 24, 2018 · 13 comments
Closed

New Lesson - Robot Framework #112

saimkhan92 opened this issue Oct 24, 2018 · 13 comments

Comments

@saimkhan92
Copy link
Contributor

@lara29 and I are planning to contribute a tutorial(primer) on the Robot Framework(wrt automated network verification). Please let us know if the tutorial outline seems appropriate.

@Mierdin @cloudtoad @jameskellynet

Robot Framework tutorial tentative outline

Chapter 1
  • Introduction
  • Installation
  • Types of libraries/keywords
  • Robot file format/syntax (introduction)
  • Basic Example 1 (without vSRX interaction)
Chapter 2
  • Project organization/directory structure
  • Robot file format/syntax (continued)
  • Basic example 2 (with vSRX interaction)
Chapter 3
  • Tags/Setup/teardown
  • Detailed example3 + Explanation (with vSRX interaction)
@Mierdin
Copy link
Member

Mierdin commented Oct 24, 2018

@saimkhan92 @lara29 This looks great. 👍 Chapter 2 and 3 are a little light on description but I think this is a good start and we can iterate on the pull request.

Have fun, and let us know if you need anything to keep moving.

@lara29
Copy link
Contributor

lara29 commented Oct 24, 2018

Thanks @Mierdin
We'll add more sub-topics into chapter 2&3 once we have completed with the basic layout.

@Mierdin Mierdin changed the title Robot Framework New Lesson - Robot Framework Oct 24, 2018
@saimkhan92
Copy link
Contributor Author

Detailed Project Outline

Chapter 1

  • Introduction
    • written in python
    • used for acceptance testing
    • keyword driven
  • Types of keywords
    • built-in, standard libnrary, external libraries, private library
  • Rules and Syntax
    • cell spacing, 4 tables
    • variable declaration(scalar, lists, dictionaries)
  • Explain 4 tables
    • settings, variables, keywords, testcases
  • Example1
    • basic syntax demo
    • import a simple private library
    • demo variables, settings, testcases (tables)
    • demo scalar variable
    • define multiple testcases in a testsuite
    • use built-in and library keywords
    • demo running a robot testsuite
    • demo a failure case

Chapter 2

  • Topology information vSRX
    • hostname: "vsrx-robot"
    • model: "VSRX"
  • Explain private library functions
  • Example1
    • use keywords from junos private library
    • passing variables from the command line, parsing them inside the robot file
    • passing arguments for private functions/keywords

Chapter 3

  • Demo user defined keywords
  • Create a separate resource file and demonstrate importing it
  • Project organization, directory structure best practices
    • data, libraries, resources, results, tests
  • Example1
    • demo user defined keywords
    • demo FOR loop for parsing a returned dictionary
    • demo logging
  • Example2
    • test setup/teardown
    • import resource file

@jameskellynet
Copy link
Member

I can't wait to try this lesson and learn this stuff. Great stuff!

@lara29
Copy link
Contributor

lara29 commented Oct 25, 2018

@Mierdin Can we pick the lesson number (like lesson-29) or will you assign it to us? Thanks!

@Mierdin
Copy link
Member

Mierdin commented Oct 25, 2018

Doesn't matter for now, pick one that's unique and we will make sure it's still unique before merge to master of this repo if applicable

@lara29
Copy link
Contributor

lara29 commented Oct 25, 2018

Okay, we'll do that, thanks!

@lara29
Copy link
Contributor

lara29 commented Oct 29, 2018

@Mierdin Can we add the package "robotframework" to the requirements.txt of utility Linux container(under /images/utility)? Or would you prefer we create a special linux container for this?

@Mierdin
Copy link
Member

Mierdin commented Oct 29, 2018 via email

@lara29
Copy link
Contributor

lara29 commented Oct 29, 2018

Thanks!

@lara29
Copy link
Contributor

lara29 commented Oct 29, 2018

@Mierdin I do not have push permission for the linux utility container. Is it possible you could add the package "robotframework" to the requirements.txt, so that I can use it for testing. Thanks!

@Mierdin
Copy link
Member

Mierdin commented Oct 30, 2018

You don't need to push it, you can add it to requirements.txt in this PR.

@Mierdin
Copy link
Member

Mierdin commented Nov 13, 2018

Closed in #125

@Mierdin Mierdin closed this as completed Nov 13, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants